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.
Sage Intacct is an industry-leading financial accounting software system with a broad set of functionalities for businesses across a number of different verticals.
This component allows creating, updating, and querying financial data including invoices, payments, vendors, and customers.
API Documentation
This component was built using the Sage Intacct API.
Connections
Web Services Credentials
Authenticate using Sage Intacct Web Services credentials.
To connect to Sage Intacct, Web Services credentials are required. These credentials consist of sender credentials (provided by Sage Intacct) and company/user credentials (created within the Sage Intacct platform).
Sage Intacct uses a dual authentication model:
- Sender credentials (Sender ID and Sender Password) are provisioned by Sage Intacct for customers or partners with an active Web Services developer license
- Company credentials (Company ID, User ID, and User Password) are created within the Sage Intacct account
Refer to Sage Intacct's Web Services documentation for additional information on authentication.
Prerequisites
- An active Sage Intacct account with a Web Services developer license
- Administrative access to configure Web Services settings
- Sender ID and Sender Password provisioned by Sage Intacct
- A Sage Intacct user account with appropriate API permissions
Setup Steps
To obtain Web Services credentials:
-
Obtain Sender Credentials:
- Contact Sage Intacct support or the account representative to request Web Services access
- Once provisioned, Sage Intacct will provide a Sender ID and Sender Password
- These credentials are used to authenticate the integration at the organization level
-
Enable Web Services in Sage Intacct:
- Log in to Sage Intacct as an administrator
- Navigate to Company > Setup > Company > Security
- Locate the Web Services authorizations section
- Enable Web Services for the organization
-
Identify Company Credentials:
- The Company ID is the unique identifier for the Sage Intacct company
- This is typically visible in the Sage Intacct URL or company settings
- Navigate to Company > Setup > Company > Company info to verify the Company ID
-
Create or Identify API User:
- Create a dedicated user account for API access or use an existing user
- Navigate to Company > Admin > Web Services users
- Ensure the user has the necessary permissions for the integration's operations
- Note the User ID (username) and User Password for this account
-
Determine Entity ID (Multi-Entity Only):
- If the Sage Intacct account uses multiple entities, determine the Entity ID for the entity to access
- Navigate to Company > Setup > Entities to view available entities
- If using a single-entity account, the Entity ID can be left blank
Configure the Connection
Enter the following credentials into the connection configuration:
- Sender ID: The Sender ID provided by Sage Intacct for Web Services authentication
- Sender Password: The Sender Password provided by Sage Intacct
- Company ID: The unique company identifier in Sage Intacct
- User ID: The username of the Web Services user account
- User Password: The password for the Web Services user account
- Entity ID (optional): The entity identifier for multi-entity environments. Leave blank for single-entity accounts.
Multi-Entity Environments
For Sage Intacct accounts with multiple entities, specify the Entity ID to connect to a specific entity. If left blank, the integration will use the default entity associated with the user account.
Security Best Practice
Use a dedicated user account for API integrations with minimal required permissions. Avoid using personal administrator accounts for Web Services authentication.
| Input | Comments | Default |
|---|---|---|
| Sender ID | The Sender ID provided by Sage Intacct for Web Services authentication. Find this in the Sage Intacct account under Company > Setup > Company > Security. | |
| Sender Password | The Sender Password for Web Services authentication. This password is set when configuring Web Services access in Sage Intacct. | |
| Company ID | The Sage Intacct Company ID. This is the unique company identifier in Sage Intacct. | |
| User ID | The User ID (username) for Web Services authentication. This must be a user with appropriate API permissions. | |
| User Password | The password for the Web Services user account. | |
| Entity ID | Optional entity ID for multi-entity Sage Intacct environments. Leave blank if the organization uses a single entity. |
Triggers
New and Updated Records
Retrieves existing and ongoing records for a selected Sage Intacct object type. Load history once, check for changes on a schedule, or both.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Resource Type | The Sage Intacct object to poll for new or updated records. | |
| Look-back Date | The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record modified on or after this date once. | |
| Show New Records | When true, newly created records are included in the trigger output. | true |
| Show Updated Records | When true, records updated since the last poll are included in the trigger output. | true |
Actions
Create AR Advance
Creates a new AR Advance.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| 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
Creates a new bill.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Bill Transaction Date | Transaction date in MM/DD/YYYY format | |
| Bill GL Posting Date | General ledger posting date in MM/DD/YYYY format | |
| Vendor ID | The vendor ID. | |
| Bill Number | A Bill Number identifier | |
| Reference Number | A reference number for the bill | |
| Description | A text description or memo for the record. | |
| Term Name | Payment term, this should be a previously created term | |
| Recommended to pay on | Payment date in MM/DD/YYYY format | |
| Attachments ID | Id of an attachment group of one or more supporting files | |
| Due Date | The payment due date in MM/DD/YYYY format. | |
| Payment Priority | The priority level for processing vendor payments. | |
| On Hold | Place this bill on hold | |
| Currency | The ISO 4217 currency code for the transaction (e.g., USD, EUR). | |
| Base Currency | The ISO 4217 base (functional) currency code for the company (e.g., USD). | |
| AP Bill Items | AP bill items, must have at least 1. Each item must be wrapped in |
<TRX_AMOUNT>100.12</TRX_AMOUNT> <TRX_AMOUNT>100.12</TRX_AMOUNT> |
Create Contact
Creates a new contact.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Contact Name | Contact name to create | |
| Print Name As | Determine the format the name should be printed. | |
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Company Name | Name of the company | |
| Name | First, middle, and last name with prefix. | |
| Prefix | The name prefix or title, such as Mr., Mrs., or Dr. | |
| First Name | The given name of the contact. | |
| Middle Name | The middle name or initial of the contact. | |
| Last Name | The last name (surname) of the contact. | |
| Contact Details | Address, phone, email, and other contact channel details. | |
| Address Line 1 | First line's address | |
| Address Line 2 | Second line's address | |
| City | The city for the mailing address. | |
| State/Province | State or province | |
| ZIP/Postal Code | ZIP or postal code. | |
| Country | The country for the mailing address. | |
| Primary Email Address | The main email address for correspondence with the contact. | |
| Secondary Email Address | An alternate email address for the contact. | |
| Primary Phone Number | The main phone number used to reach the contact. | |
| Secondary Phone Number | An alternate phone number for the contact. | |
| Cellular Phone Number | The mobile phone number for the contact. | |
| Pager Number | The pager number for the contact. | |
| Fax Number | The fax number for sending documents to the contact. | |
| Primary URL | The main website or homepage associated with the contact. | |
| Secondary URL | An additional website associated with the contact. | |
| Tax Information | Tax ID, taxable status, and tax group. | |
| Tax ID | Tax identification number (EIN/SSN) | |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Contact Tax Group Name | Name of the tax group |
Create Customer
Creates a customer and specifies a display contact and a contact list (provided via customer contacts).
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| 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 | The display name of the customer in Sage Intacct. | |
| 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 | When true, the record is active and available for use. When false, the record is inactive. | |
| Company Name | Name of the company | |
| Print Name As | Determine the format the name should be printed. | |
| Name | First, middle, and last name with prefix. | |
| Prefix | The name prefix or title, such as Mr., Mrs., or Dr. | |
| First Name | The given name of the contact. | |
| Middle Name | The middle name or initial of the contact. | |
| Last Name | The last name (surname) of the contact. | |
| Contact Details | Address, phone, email, and other contact channel details. | |
| Address Line 1 | First line's address | |
| Address Line 2 | Second line's address | |
| City | The city for the mailing address. | |
| State/Province | State or province | |
| ZIP/Postal Code | ZIP or postal code. | |
| Country | The country for the mailing address. | |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | |
| Primary Email Address | The main email address for correspondence with the contact. | |
| Secondary Email Address | An alternate email address for the contact. | |
| Primary Phone Number | The main phone number used to reach the contact. | |
| Secondary Phone Number | An alternate phone number for the contact. | |
| Cellular Phone Number | The mobile phone number for the contact. | |
| Pager Number | The pager number for the contact. | |
| Fax Number | The fax number for sending documents to the contact. | |
| Primary URL | The main website or homepage associated with the contact. | |
| Secondary URL | An additional website associated with the contact. | |
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all 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 Accounts | GL group, offset AR GL account, and default revenue GL account numbers. | |
| GL Group Name | Name of the GL group | |
| Offset AR GL Account No | Offset AR GL account number | |
| Default Revenue GL Account No | Default AR GL account number | |
| Territory ID | Identifier for the territory | |
| Attachments ID | Id of an attachment group of one or more supporting files | |
| Billing and Delivery Preferences | Payment term, delivery method, default invoice message, and shipping method. | |
| Payment Term | A previously created payment term | |
| 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 | |
| Shipping Method | The method used for shipping goods, such as FedEx Ground or UPS. | |
| Resale Number | Resale certificate number for tax-exempt purchases | |
| Tax Information | Tax ID, taxable status, and tax group. | |
| Tax ID | Tax identification number (EIN/SSN) | |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Contact Tax Group Name | Name of the tax group | |
| Credit Limit | The maximum outstanding balance allowed before transactions are blocked. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Comments | Additional comments | |
| Default Currency | The ISO 4217 currency code used as the default for transactions (e.g., USD, EUR). | |
| Print Options | Document template assignments for invoices, quotes, orders, and adjustments. | |
| AR Invoice Template Name | Template name for AR invoices | |
| OE Quote Template Name | Template name for OE quotes | |
| OE Order Template Name | Template name for OE orders | |
| OE List Template Name | Template name for OE lists | |
| OE Invoice Template Name | Template name for OE invoices | |
| OE Adjustment Template Name | Template name for OE adjustments | |
| OE Other Template Name | Template name for other OE documents | |
| Contact Roles | Primary, bill-to, and ship-to contact assignments. | |
| 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 | The Sage Intacct connection to use. | |
| Invoice Line Items | Invoice lines, must have at least 1. Each item must be wrapped in |
|
| 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 | The unique invoice number used to identify the invoice. | |
| 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. | |
| Currency and Exchange Rate | Base currency, transaction currency, and exchange rate details. | |
| Base Currency | The ISO 4217 base (functional) currency code for the company (e.g., USD). | |
| 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 | The Sage Intacct connection to use. | |
| Project Name | The display name used to identify the project. for the to-be-created object. | |
| Project Category | The category classification for the project, such as Contract or Internal. 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 | A detailed description of the project scope or purpose. for the to-be-created object. | |
| Parent Project ID | The ID of the parent project for hierarchical project relationships. for the to-be-created object. | |
| Invoice with Parent | Use false for No, true for Yes. (Default: false) | false |
| Project Type | The type classification for the project. for the to-be-created object. | |
| Project Status | The current status of the project, such as In Progress or Completed. 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 | The Sage Intacct connection to use. | |
| 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 | The display name of the vendor in Sage Intacct. | |
| 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 | When true, the record is active and available for use. When false, the record is inactive. | |
| Company Name | Name of the company | |
| Print Name As | Determine the format the name should be printed. | |
| Name | First, middle, and last name with prefix. | |
| Prefix | The name prefix or title, such as Mr., Mrs., or Dr. | |
| First Name | The given name of the contact. | |
| Middle Name | The middle name or initial of the contact. | |
| Last Name | The last name (surname) of the contact. | |
| Contact Details | Address, phone, email, and other contact channel details. | |
| Address Line 1 | First line's address | |
| Address Line 2 | Second line's address | |
| City | The city for the mailing address. | |
| State/Province | State or province | |
| ZIP/Postal Code | ZIP or postal code. | |
| Country | The country for the mailing address. | |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | |
| Primary Email Address | The main email address for correspondence with the contact. | |
| Secondary Email Address | An alternate email address for the contact. | |
| Primary Phone Number | The main phone number used to reach the contact. | |
| Secondary Phone Number | An alternate phone number for the contact. | |
| Cellular Phone Number | The mobile phone number for the contact. | |
| Pager Number | The pager number for the contact. | |
| Fax Number | The fax number for sending documents to the contact. | |
| Primary URL | The main website or homepage associated with the contact. | |
| Secondary URL | An additional website associated with the contact. | |
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all lists. | |
| Vendor Type ID | The identifier for the vendor type classification. | |
| Parent Vendor ID | The ID of the parent vendor for hierarchical relationships. | |
| GL Accounts | GL group, default expense GL account, and offset GL account numbers. | |
| GL Group Name | Name of the GL group | |
| Default Expense GL Account No | The default GL account number used for expense transactions. | |
| Offset GL Account No | The GL account number used for offset entries. | |
| Tax Information | Tax ID, taxable status, and tax group. | |
| Tax ID | Tax identification number (EIN/SSN) | |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Contact Tax Group Name | Name of the tax group | |
| Form 1099 | Form 1099 tax reporting details. | |
| Form 1099 Name | The name printed on the 1099 form for tax reporting. | |
| Form 1099 Type | The 1099 form type, such as MISC or NEC. | |
| Form 1099 Box | The box number on the 1099 form for categorizing income. | |
| Attachments ID | Id of an attachment group of one or more supporting files | |
| Credit Limit | The maximum outstanding balance allowed before transactions are blocked. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Payment Settings | Payment method, terms, and notification preferences. | |
| Do Not Pay | When true, the vendor is flagged as do-not-pay and payment processing is blocked. | |
| Preferred Payment Method | The vendor's preferred payment method, such as Check, EFT, or Credit Card. | |
| Payment Term | A previously created payment term | |
| Send Automatic Payment Notification | When true, the vendor receives an automatic email notification when a payment is made. | |
| Merge Payment Requests | When true, multiple payment requests for this vendor are combined into a single payment. | |
| Vendor Billing Type | The billing type assigned to the vendor, such as Standard or Retainer. | |
| Payment Priority | The priority level for processing vendor payments. | |
| Term Discount Displayed On Check Stub | When true, the payment term discount amount is printed on the check stub. | |
| Comments | Additional comments | |
| Default Currency | The ISO 4217 currency code used as the default for transactions (e.g., USD, EUR). | |
| Contact Roles | Primary, pay-to, and return-to contact assignments. | |
| Primary Contact Name | Primary contact. If blank system will use DISPLAYCONTACT. | |
| Pay To Contact Name | The name of the contact designated to receive payments. | |
| Return To Contact Name | The name of the contact for handling purchase returns. | |
| ACH Banking | ACH bank account and routing details. | |
| ACH Enabled | When true, ACH electronic payments are enabled for this vendor. | |
| ACH Bank Routing No | The 9-digit ABA routing number for the vendor's bank. | |
| ACH Bank Account No | The bank account number for ACH payments to the vendor. | |
| ACH Bank Account Type | The bank account type, such as Checking or Savings. | |
| ACH Bank Account Class | The bank account class, such as Business or Personal. | |
| Vendor Account No | The account number assigned by the vendor for reference on payments. | |
| Location Assigned Account No Displayed On Check Stub | When true, the location-specific vendor account number is printed on the 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 | The Sage Intacct connection to use. | |
| Object | Type of object to delete | |
| Keys | A key or comma-separated list (123,456) of keys (RECORDNO's) to delete |
Get AP Payment
Retrieves a single AP Payment.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get AR Adjustment
Retrieves a single AR Adjustment.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get AR Adjustment Line
Retrieves a single AR Adjustment Line.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get AR Advance
Retrieves a single AR Advance.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get AR Payment
Retrieves a single AR Payment.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get Bill
Retrieves a single bill.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get Contact
Retrieves a single contact.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get Customer
Retrieves a single customer.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get Invoice
Retrieves a single invoice.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Get Project
Retrieves a project by record number.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier of the project to retrieve. |
Get Vendor
Retrieves a single vendor.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | |
| Record No | The unique record number identifier |
Query and List Records
Lists specified criteria based on a query.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| 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 filter expression to filter the records |
Raw Request
Sends a raw HTTP request to Sage Intacct.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Data | The raw XML function to execute. Add the structure as per the Sage Intacct API documentation. For the provided default example, see the Query and List Contacts function. Authentication is already handled by the action. | |
| Header | A list of headers to send with the request. Note: Sage Intacct API is XML based. Content-Type: 'application/xml' header is already added. | |
| Response Type | The type of data format expected in the response. Select 'JSON' for JSON format or 'XML' for raw XML text. | 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
Updates an existing AR Adjustment.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| 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 |
|
| 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
Updates an existing AR Advance.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| 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
Updates an existing contact.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Contact Name | Full name of the contact | |
| Print Name As | Determine the format the name should be printed. | |
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Company Name | Name of the company | |
| Name | First, middle, and last name with prefix. | |
| Prefix | The name prefix or title, such as Mr., Mrs., or Dr. | |
| First Name | The given name of the contact. | |
| Middle Name | The middle name or initial of the contact. | |
| Last Name | The last name (surname) of the contact. | |
| Contact Details | Address, phone, email, and other contact channel details. | |
| Address Line 1 | First line's address | |
| Address Line 2 | Second line's address | |
| City | The city for the mailing address. | |
| State/Province | State or province | |
| ZIP/Postal Code | ZIP or postal code. | |
| Country | The country for the mailing address. | |
| Primary Email Address | The main email address for correspondence with the contact. | |
| Secondary Email Address | An alternate email address for the contact. | |
| Primary Phone Number | The main phone number used to reach the contact. | |
| Secondary Phone Number | An alternate phone number for the contact. | |
| Cellular Phone Number | The mobile phone number for the contact. | |
| Pager Number | The pager number for the contact. | |
| Fax Number | The fax number for sending documents to the contact. | |
| Primary URL | The main website or homepage associated with the contact. | |
| Secondary URL | An additional website associated with the contact. | |
| Tax Information | Tax ID, taxable status, and tax group. | |
| Tax ID | Tax identification number (EIN/SSN) | |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Contact Tax Group Name | Name of the tax group |
Update Customer
Updates an existing customer in Intacct. The customer is identified by the customer ID.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| 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 | The display name of the customer in Sage Intacct. | |
| 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 | When true, the record is active and available for use. When false, the record is inactive. | |
| Company Name | Name of the company | |
| Print Name As | Determine the format the name should be printed. | |
| Name | First, middle, and last name with prefix. | |
| Prefix | The name prefix or title, such as Mr., Mrs., or Dr. | |
| First Name | The given name of the contact. | |
| Middle Name | The middle name or initial of the contact. | |
| Last Name | The last name (surname) of the contact. | |
| Contact Details | Address, phone, email, and other contact channel details. | |
| Address Line 1 | First line's address | |
| Address Line 2 | Second line's address | |
| City | The city for the mailing address. | |
| State/Province | State or province | |
| ZIP/Postal Code | ZIP or postal code. | |
| Country | The country for the mailing address. | |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | |
| Primary Email Address | The main email address for correspondence with the contact. | |
| Secondary Email Address | An alternate email address for the contact. | |
| Primary Phone Number | The main phone number used to reach the contact. | |
| Secondary Phone Number | An alternate phone number for the contact. | |
| Cellular Phone Number | The mobile phone number for the contact. | |
| Pager Number | The pager number for the contact. | |
| Fax Number | The fax number for sending documents to the contact. | |
| Primary URL | The main website or homepage associated with the contact. | |
| Secondary URL | An additional website associated with the contact. | |
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all 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 Accounts | GL group, offset AR GL account, and default revenue GL account numbers. | |
| GL Group Name | Name of the GL group | |
| Offset AR GL Account No | Offset AR GL account number | |
| Default Revenue GL Account No | Default AR GL account number | |
| Territory ID | Identifier for the territory | |
| Attachments ID | Id of an attachment group of one or more supporting files | |
| Billing and Delivery Preferences | Payment term, delivery method, default invoice message, and shipping method. | |
| Payment Term | A previously created payment term | |
| 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 | |
| Shipping Method | The method used for shipping goods, such as FedEx Ground or UPS. | |
| Resale Number | Resale certificate number for tax-exempt purchases | |
| Tax Information | Tax ID, taxable status, and tax group. | |
| Tax ID | Tax identification number (EIN/SSN) | |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Contact Tax Group Name | Name of the tax group | |
| Credit Limit | The maximum outstanding balance allowed before transactions are blocked. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Comments | Additional comments | |
| Default Currency | The ISO 4217 currency code used as the default for transactions (e.g., USD, EUR). | |
| Print Options | Document template assignments for invoices, quotes, orders, and adjustments. | |
| AR Invoice Template Name | Template name for AR invoices | |
| OE Quote Template Name | Template name for OE quotes | |
| OE Order Template Name | Template name for OE orders | |
| OE List Template Name | Template name for OE lists | |
| OE Invoice Template Name | Template name for OE invoices | |
| OE Adjustment Template Name | Template name for OE adjustments | |
| OE Other Template Name | Template name for other OE documents | |
| Contact Roles | Primary, bill-to, and ship-to contact assignments. | |
| 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 | The Sage Intacct connection to use. | |
| 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 | The unique invoice number used to identify the invoice. | |
| Reference Number | A reference number for the invoice | |
| Description | The description of the invoice. | |
| Contact Name | Full name of the contact | |
| Currency and Exchange Rate | Base currency, transaction currency, and exchange rate details. | |
| Base Currency | The ISO 4217 base (functional) currency code for the company (e.g., USD). | |
| Currency | The ISO 4217 currency code for the transaction (e.g., USD, EUR). | |
| 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 |
Update Project
Updates an existing project.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Project ID | Project ID to update. | |
| Project Name | The display name used to identify the project. for the to-be-updated object. | |
| Project Category | The category classification for the project, such as Contract or Internal. for the to-be-updated object. | |
| Project Description | A detailed description of the project scope or purpose. for the to-be-updated object. | |
| Parent Project ID | The ID of the parent project for hierarchical project relationships. for the to-be-updated object. | |
| Invoice with Parent | Boolean update field for setting true, false, or empty values. | |
| Project Type | The type classification for the project. for the to-be-updated object. | |
| Project Status | The current status of the project, such as In Progress or Completed. for the to-be-updated object. | |
| Status | Boolean update field for setting true, false, or empty values. | |
| Additional Fields | Additional fields that are not covered by the standard inputs. |
Update Vendor
Updates an existing vendor.
| Input | Comments | Default |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| 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 | The display name of the vendor in Sage Intacct. | |
| 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 | When true, the record is active and available for use. When false, the record is inactive. | |
| Company Name | Name of the company | |
| Print Name As | Determine the format the name should be printed. | |
| Name | First, middle, and last name with prefix. | |
| Prefix | The name prefix or title, such as Mr., Mrs., or Dr. | |
| First Name | The given name of the contact. | |
| Middle Name | The middle name or initial of the contact. | |
| Last Name | The last name (surname) of the contact. | |
| Contact Details | Address, phone, email, and other contact channel details. | |
| Address Line 1 | First line's address | |
| Address Line 2 | Second line's address | |
| City | The city for the mailing address. | |
| State/Province | State or province | |
| ZIP/Postal Code | ZIP or postal code. | |
| Country | The country for the mailing address. | |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | |
| Primary Email Address | The main email address for correspondence with the contact. | |
| Secondary Email Address | An alternate email address for the contact. | |
| Primary Phone Number | The main phone number used to reach the contact. | |
| Secondary Phone Number | An alternate phone number for the contact. | |
| Cellular Phone Number | The mobile phone number for the contact. | |
| Pager Number | The pager number for the contact. | |
| Fax Number | The fax number for sending documents to the contact. | |
| Primary URL | The main website or homepage associated with the contact. | |
| Secondary URL | An additional website associated with the contact. | |
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all lists. | |
| Vendor Type ID | The identifier for the vendor type classification. | |
| Parent Vendor ID | The ID of the parent vendor for hierarchical relationships. | |
| GL Accounts | GL group, default expense GL account, and offset GL account numbers. | |
| GL Group Name | Name of the GL group | |
| Default Expense GL Account No | The default GL account number used for expense transactions. | |
| Offset GL Account No | The GL account number used for offset entries. | |
| Tax Information | Tax ID, taxable status, and tax group. | |
| Tax ID | Tax identification number (EIN/SSN) | |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Contact Tax Group Name | Name of the tax group | |
| Form 1099 | Form 1099 tax reporting details. | |
| Form 1099 Name | The name printed on the 1099 form for tax reporting. | |
| Form 1099 Type | The 1099 form type, such as MISC or NEC. | |
| Form 1099 Box | The box number on the 1099 form for categorizing income. | |
| Attachments ID | Id of an attachment group of one or more supporting files | |
| Credit Limit | The maximum outstanding balance allowed before transactions are blocked. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Payment Settings | Payment method, terms, and notification preferences. | |
| Do Not Pay | When true, the vendor is flagged as do-not-pay and payment processing is blocked. | |
| Preferred Payment Method | The vendor's preferred payment method, such as Check, EFT, or Credit Card. | |
| Payment Term | A previously created payment term | |
| Send Automatic Payment Notification | When true, the vendor receives an automatic email notification when a payment is made. | |
| Merge Payment Requests | When true, multiple payment requests for this vendor are combined into a single payment. | |
| Vendor Billing Type | The billing type assigned to the vendor, such as Standard or Retainer. | |
| Payment Priority | The priority level for processing vendor payments. | |
| Term Discount Displayed On Check Stub | When true, the payment term discount amount is printed on the check stub. | |
| Comments | Additional comments | |
| Default Currency | The ISO 4217 currency code used as the default for transactions (e.g., USD, EUR). | |
| Contact Roles | Primary, pay-to, and return-to contact assignments. | |
| Primary Contact Name | Primary contact. If blank system will use DISPLAYCONTACT. | |
| Pay To Contact Name | The name of the contact designated to receive payments. | |
| Return To Contact Name | The name of the contact for handling purchase returns. | |
| ACH Banking | ACH bank account and routing details. | |
| ACH Enabled | When true, ACH electronic payments are enabled for this vendor. | |
| ACH Bank Routing No | The 9-digit ABA routing number for the vendor's bank. | |
| ACH Bank Account No | The bank account number for ACH payments to the vendor. | |
| ACH Bank Account Type | The bank account type, such as Checking or Savings. | |
| ACH Bank Account Class | The bank account class, such as Business or Personal. | |
| Vendor Account No | The account number assigned by the vendor for reference on payments. | |
| Location Assigned Account No Displayed On Check Stub | When true, the location-specific vendor account number is printed on the 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 |