Sage Intacct Component
Manage financial data including invoices, payments, vendors, and customers in Sage Intacct.
Component key: sage-intacct
Description
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 you to create, update, and query financial data including invoices, payments, vendors, and customers.
API Documentation
This component was built using the Sage Intacct API.
Connections
Sage Intacct Connection
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.
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.
Use a dedicated user account for API integrations with minimal required permissions. Avoid using personal administrator accounts for Web Services authentication.
| Input | Notes | Example |
|---|---|---|
| Company ID | Your Sage Intacct Company ID. This is your unique company identifier in Sage Intacct. | ACME_INC |
| Entity ID | Optional entity ID for multi-entity Sage Intacct environments. Leave blank if your organization uses a single entity. | ENTITY_001 |
| Sender ID | The Sender ID provided by Sage Intacct for Web Services authentication. Find this in your Sage Intacct account under Company > Setup > Company > Security. | ACME_CORP |
| Sender Password | The Sender Password for Web Services authentication. This password is set when configuring Web Services access in Sage Intacct. | |
| User ID | The User ID (username) for Web Services authentication. This must be a user with appropriate API permissions. | apiuser@acme.com |
| User Password | The password for the Web Services user account. |
Data Sources
Select Contact
A picklist of contacts in Sage Intacct. | key: selectContact | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Return Contact Name | Turn on to return the Contact Name instead of the Record No. | false |
Select Customer
A picklist of customers in Sage Intacct. | key: selectCustomer | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Return ID | Turn on to return the ID of the object (e.g. CUSTOMERID, PROJECTID, VENDORID, etc.) instead of the Record No. | false |
Select Invoice
A picklist of AR invoices in Sage Intacct. | key: selectInvoice | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. |
Select Project
A picklist of projects in Sage Intacct. | key: selectProject | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Return ID | Turn on to return the ID of the object (e.g. CUSTOMERID, PROJECTID, VENDORID, etc.) instead of the Record No. | false |
Select Vendor
A picklist of vendors in Sage Intacct. | key: selectVendor | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Return ID | Turn on to return the ID of the object (e.g. CUSTOMERID, PROJECTID, VENDORID, etc.) instead of the Record No. | false |
Actions
Create AR Advance
Creates a new AR Advance. | key: createARAdvance
| Input | Notes | Example |
|---|---|---|
| Additional XML Tags | Additional XML tags that might not be covered by the standard inputs. | |
| AR Advance Items | Advance lines, must have at least 1. Check Documentation for additional tags. | |
| 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. | CUST-12345 |
| 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. | 1020 |
| Payment Date | Date the advance payment was made, in the mm/dd/yyyy format. | 09/12/2021 |
| Payment Method | Payment method used for the advance. | Cash |
| 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. | 09/12/2021 |
| Undeposited Account No | Undeposited funds account number. A create request must contain FINANCIALENTITY or UNDEPOSITEDACCOUNTNO when automatic summaries are enabled. | 1020 |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"example"
],
"controlid": [
"1705003571234"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"UtilizeCore"
],
"companyid": [
"example-imp"
],
"locationid": [
"example-location"
],
"sessiontimestamp": [
"2024-01-10T16:45:20+00:00"
],
"sessiontimeout": [
"2024-01-11T00:45:20+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"create"
],
"controlid": [
"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
],
"key": [
"9834"
]
}
]
}
]
}
}
}
Create Bill
Create a new bill. | key: createBill
| Input | Notes | Example |
|---|---|---|
| AP Bill Items | AP bill items, must have at least 1. Each item must be wrapped in <APBILLITEM></APBILLITEM> tags. | |
| Attachments ID | Id of an attachment group of one or more supporting files | ATT-001 |
| Base Currency | Base currency code | USD |
| Bill Number | A Bill Number identifier | BILL-2024-001 |
| Bill Transaction Date | Transaction date in MM/DD/YYYY format | 12/06/2023 |
| Bill GL Posting Date | General ledger posting date in MM/DD/YYYY format | 12/06/2023 |
| Connection | The Sage Intacct connection to use. | |
| Currency | Transaction currency code | USD |
| Description | Description of the bill | Office supplies for Q1 2024 |
| Reference Number | A reference number for the bill | REF-2024-5678 |
| Due Date | Due date | 12/06/2023 |
| On Hold | Place this bill on hold | |
| Payment Priority | High | |
| Recommended to pay on | Payment date in MM/DD/YYYY format | 12/06/2023 |
| Term Name | Payment term, this should be a previously created term | Net 30 |
| Vendor ID | The vendor ID. | V-01879 |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"testgroup"
],
"controlid": [
"1704925436123"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"TestUser"
],
"companyid": [
"testgroup-imp"
],
"locationid": [
"firstchoice"
],
"sessiontimestamp": [
"2024-01-10T22:23:57+00:00"
],
"sessiontimeout": [
"2024-01-11T06:23:57+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"create"
],
"controlid": [
"49143589-7eff-4a44-a049-378ed812345"
],
"data": [
{
"$": {
"listtype": "objects",
"count": "1"
},
"apbill": [
{
"RECORDNO": [
"4760"
]
}
]
}
]
}
]
}
]
}
}
}
Create Contact
Creates a new contact. | key: createContact
| Input | Notes | Example |
|---|---|---|
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Address Line 1 | First line's address | 123 Main St. |
| Address Line 2 | Second line's address | Suite 400 |
| Cellular Phone Number | Cellular phone number | +1-555-234-5678 |
| City | City name. | New York |
| Company Name | Name of the company | Acme Corporation |
| Connection | The Sage Intacct connection to use. | |
| Contact Name | Contact name to create | John Doe |
| Contact Tax Group Name | Name of the tax group | Standard Tax Group |
| Country | Country name. | United States |
| Fax Number | Fax number | +1-555-345-6789 |
| First Name | First name | John |
| Last Name | Last name | Doe |
| Middle Name | Middle name | A. |
| Pager Number | Pager number | +1-555-PAGER-01 |
| Prefix | Prefix for the name | Mr. |
| Primary Email Address | Primary email address | john.doe@example.com |
| Primary Phone Number | Primary phone number | +1-555-123-4567 |
| Primary URL | Primary URL | https://www.example.com |
| Print Name As | Determine the format the name should be printed. | John A. Doe |
| Secondary Email Address | Secondary email address | jane.smith@example.com |
| Secondary Phone Number | Secondary phone number | +1-555-987-6543 |
| Secondary URL | Secondary URL | https://www.example.com |
| State/Province | State or province | NY |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Tax ID | Tax identification number (EIN/SSN) | 12-3456789 |
| ZIP/Postal Code | ZIP or postal code. | 10001 |
{
"data": {
"_status": "success",
"_functionName": "create",
"_controlId": "b8ff1fd1-10ac-4a3c-aa5b-2cf8494f1234",
"_listType": "objects",
"_count": 1,
"_data": [
{
"RECORDNO": "19713",
"CONTACTNAME": "John Doe"
}
]
}
}
Create Customer
Creates a customer and specifies a display contact and a contact list (provided via customer contacts). | key: createCustomer
| Input | Notes | Example |
|---|---|---|
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Address Line 1 | First line's address | 123 Main St. |
| Address Line 2 | Second line's address | Suite 400 |
| Attachments ID | Id of an attachment group of one or more supporting files | ATT-001 |
| Bill To Contact Name | Bill to contact. If blank system will use DISPLAYCONTACT. | Jane Smith |
| Cellular Phone Number | Cellular phone number | +1-555-234-5678 |
| City | City name. | New York |
| Comments | Additional comments | |
| Company Name | Name of the company | Acme Corporation |
| Connection | The Sage Intacct connection to use. | |
| Contact Tax Group Name | Name of the tax group | Standard Tax Group |
| Country | Country name. | United States |
| Credit Limit | Credit limit amount | 50000 |
| 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. | CUST-12345 |
| Customer Name | Customer name | Global Tech Solutions |
| Customer Type ID | Identifier for the type of customer | TYPE-001 |
| Custom Fields | Custom field names and values as defined for this object | |
| Default Currency | Default currency code | USD |
| Default Invoice Message | Default message for invoices | |
| Default Revenue GL Account No | Default AR GL account number | 4000 |
| 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. | |
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all lists. | |
| Fax Number | Fax number | +1-555-345-6789 |
| First Name | First name | John |
| GL Group Name | Name of the GL group | Default GL Group |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | US |
| Last Name | Last name | Doe |
| Middle Name | Middle name | A. |
| Offset AR GL Account No | Offset AR GL account number | 1200 |
| 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. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Pager Number | Pager number | +1-555-PAGER-01 |
| Parent Customer ID | Identifier of the parent customer | CUST-PARENT-001 |
| Payment Term | A previously created payment term | Net 30 |
| Prefix | Prefix for the name | Mr. |
| Primary Contact Name | Primary contact. If blank system will use DISPLAYCONTACT. | John Doe |
| Primary Email Address | Primary email address | john.doe@example.com |
| Primary Phone Number | Primary phone number | +1-555-123-4567 |
| Primary URL | Primary URL | https://www.example.com |
| Print Name As | Determine the format the name should be printed. | John A. Doe |
| Print Option AR Invoice Template Name | Template name for AR invoices | |
| Print Option OE Adjustment Template Name | Template name for OE adjustments | |
| Print Option OE Invoice Template Name | Template name for OE invoices | |
| Print Option OE List Template Name | Template name for OE lists | |
| Print Option OE Order Template Name | Template name for OE orders | |
| Print Option OE Other Template Name | Template name for other OE documents | |
| Print Option OE Quote Template Name | Template name for OE quotes | |
| Resale Number | Resale certificate number for tax-exempt purchases | RSL-123456 |
| Restricted Department | Restricted department IDs. Use if OBJECTRESTRICTION is Restricted | |
| Restricted Location | Restricted location ID. Use if OBJECTRESTRICTION is Restricted | |
| Restriction Type | Type of restriction | |
| Sales Rep Employee ID | Employee ID of the sales representative | EMP-001 |
| Secondary Email Address | Secondary email address | jane.smith@example.com |
| Secondary Phone Number | Secondary phone number | +1-555-987-6543 |
| Secondary URL | Secondary URL | https://www.example.com |
| Shipping Method | Shipping method | FedEx Ground |
| Ship To Contact Name | Ship to contact. If blank system will use DISPLAYCONTACT. | Bob Johnson |
| State/Province | State or province | NY |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Tax ID | Tax identification number (EIN/SSN) | 12-3456789 |
| Territory ID | Identifier for the territory | TERR-001 |
| ZIP/Postal Code | ZIP or postal code. | 10001 |
{
"data": {
"_status": "success",
"_functionName": "create",
"_controlId": "8245cb67-8fd6-4785-9008-121acd2d1234",
"_listType": "objects",
"_count": 1,
"_data": [
{
"RECORDNO": "12499",
"CUSTOMERID": "C-01564"
}
]
}
}
Create Invoice
Creates an invoice. | key: createInvoice
| Input | Notes | Example |
|---|---|---|
| Attachments ID | Id of an attachment group of one or more supporting files | ATT-001 |
| Base Currency | Base currency code | USD |
| Bill To Contact Name | The name of the contact to bill to. This should be an existing contact in Intacct. | Jane Smith |
| Connection | The Sage Intacct connection to use. | |
| Currency | The currency of the invoice. | USD |
| Customer ID | The customer ID to create the invoice for. | C-00269 |
| Custom Fields | Custom field names and values as defined for this object | |
| Date Created | Invoice date creation date | 12/06/2023 |
| GL Date Posted | Invoice General Ledger posted date | 12/06/2023 |
| Description | The description of the invoice. | Some description |
| Due Date | The due date of the invoice. | 12/06/2023 |
| Exchange Rate Date | Exchange rate date for the invoice | 12/06/2023 |
| Exchange Rate Type | Exchange rate type for the invoice | Intacct Daily Rate |
| External ID | An external ID for the invoice | 1234 |
| Invoice Line Items | Invoice lines, must have at least 1. Each item must be wrapped in <lineitem></lineitem> tags. | |
| Invoice Number | Invoice number | 1234 |
| No GL | Do not post to GL. Use false for No, true for Yes. | |
| Reference Number | A reference number for the invoice | 1234 |
| Record No | A Summary RECORDNO for the invoice. | 12345 |
| Ship To Contact Name | The name of the contact to ship to. This should be an existing contact in Intacct. | Bob Johnson |
| Term Name | Payment term, this should be a previously created term | Net 30 |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"example"
],
"controlid": [
"1705003571234"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"UtilizeCore"
],
"companyid": [
"example-imp"
],
"locationid": [
"example-location"
],
"sessiontimestamp": [
"2024-01-11T20:06:13+00:00"
],
"sessiontimeout": [
"2024-01-12T04:06:13+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"create_invoice"
],
"controlid": [
"3a7463e3-d65e-4056-be1a-158f2cf51234"
],
"key": [
"4774"
]
}
]
}
]
}
}
}
Create Project
Creates a new project. | key: createProject
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that are not covered by the standard inputs. | |
| Connection | The Sage Intacct connection to use. | |
| Invoice with Parent | Use false for No, true for Yes. (Default: false) | false |
| Parent Project ID | Parent project ID for the to-be-created object. | 21-1234 |
| Project Category | Project category for the to-be-created object. | Contract |
| Project Description | Project description for the to-be-created object. | This is a sample project |
| 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. | 21-1234 |
| Project Name | Project name for the to-be-created object. | Sample Project |
| Project Status | Project status for the to-be-created object. | In Progress |
| Project Type | Project type for the to-be-created object. | Type 1 |
| Status | Use false for Inactive, true for Active. (Default: true) | true |
{
"data": {
"RECORDNO": "90320",
"PROJECTID": "21-3457"
}
}
Create Vendor
Creates a new vendor. | key: createVendor
| Input | Notes | Example |
|---|---|---|
| ACH Bank Account Class | Business | |
| ACH Bank Account No | 1234567890 | |
| ACH Bank Account Type | Checking | |
| ACH Bank Routing No | 021000021 | |
| ACH Enabled | ||
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Address Line 1 | First line's address | 123 Main St. |
| Address Line 2 | Second line's address | Suite 400 |
| Attachments ID | Id of an attachment group of one or more supporting files | ATT-001 |
| Cellular Phone Number | Cellular phone number | +1-555-234-5678 |
| City | City name. | New York |
| Comments | Additional comments | |
| Company Name | Name of the company | Acme Corporation |
| Connection | The Sage Intacct connection to use. | |
| Contact Tax Group Name | Name of the tax group | Standard Tax Group |
| Country | Country name. | United States |
| Credit Limit | Credit limit amount | 50000 |
| Custom Fields | Custom field names and values as defined for this object | |
| Default Currency | Default currency code | USD |
| Default Expense GL Account No | 6000 | |
| Do Not Pay | ||
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all lists. | |
| Fax Number | Fax number | +1-555-345-6789 |
| First Name | First name | John |
| Form 1099 Box | 7 | |
| Form 1099 Name | John Doe | |
| Form 1099 Type | MISC | |
| GL Group Name | Name of the GL group | Default GL Group |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | US |
| Last Name | Last name | Doe |
| Location Assigned Account No Displayed On Check Stub | ||
| Merge Payment Requests | ||
| Middle Name | Middle name | A. |
| Offset GL Account No | 2000 | |
| 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. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Pager Number | Pager number | +1-555-PAGER-01 |
| Parent Vendor ID | VENDOR-PARENT-001 | |
| Payment Priority | High | |
| Payment Term | A previously created payment term | Net 30 |
| Pay To Contact Name | John Doe | |
| Preferred Payment Method | Check | |
| Prefix | Prefix for the name | Mr. |
| Primary Contact Name | Primary contact. If blank system will use DISPLAYCONTACT. | John Doe |
| Primary Email Address | Primary email address | john.doe@example.com |
| Primary Phone Number | Primary phone number | +1-555-123-4567 |
| Primary URL | Primary URL | https://www.example.com |
| Print Name As | Determine the format the name should be printed. | John A. Doe |
| Restricted Department | Restricted department IDs. Use if OBJECTRESTRICTION is Restricted | |
| Restricted Location | Restricted location ID. Use if OBJECTRESTRICTION is Restricted | |
| Restriction Type | Type of restriction | |
| Return To Contact Name | Jane Smith | |
| Secondary Email Address | Secondary email address | jane.smith@example.com |
| Secondary Phone Number | Secondary phone number | +1-555-987-6543 |
| Secondary URL | Secondary URL | https://www.example.com |
| Send Automatic Payment Notification | ||
| State/Province | State or province | NY |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Tax ID | Tax identification number (EIN/SSN) | 12-3456789 |
| Term Discount Displayed On Check Stub | ||
| Vendor Account No | VEND-ACC-001 | |
| Vendor Billing Type | Standard | |
| 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-001 |
| Vendor Name | Acme Supplies Inc. | |
| Vendor Type ID | TYPE-001 | |
| ZIP/Postal Code | ZIP or postal code. | 10001 |
{
"data": {
"_status": "success",
"_functionName": "create",
"_controlId": "a30ea5c6-565b-4c31-95a7-b503fe071234",
"_listType": "objects",
"_count": 1,
"_data": [
{
"RECORDNO": "1234",
"VENDORID": "V-12345"
}
]
}
}
Delete Object
Deletes different objects in Sage Intacct. | key: deleteObject
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Keys | A key or comma-separated list (123,456) of keys (RECORDNO's) to delete | 123 |
| Object | Type of object to delete |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"example"
],
"controlid": [
"1705003571234"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"UtilizeCore"
],
"companyid": [
"example-imp"
],
"locationid": [
"example-location"
],
"sessiontimestamp": [
"2024-01-15T15:20:00+00:00"
],
"sessiontimeout": [
"2024-01-15T23:20:00+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"delete"
],
"controlid": [
"c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f"
]
}
]
}
]
}
}
}
Get AP Payment
Retrieve a single AP Payment. | key: getApPayment
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "dff0b3b1-af3f-4e52-9260-917ab4f61234",
"_listType": "APPYMT",
"_count": 0,
"_data": []
}
}
Get AR Adjustment
Retrieve a single AR Adjustment. | key: getARAdjustment
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f",
"_listType": "ARADJUSTMENT",
"_count": 1,
"_data": [
{
"RECORDNO": "8652",
"RECORDTYPE": "ra",
"RECORDID": "ADJ-2024-001",
"CUSTOMERID": "C-01234",
"CUSTOMERNAME": "Acme Corporation",
"CUSTOMERKEY": "12499",
"STATE": "Posted",
"RAWSTATE": "A",
"DOCNUMBER": "ADJ-2024-001",
"DESCRIPTION": "Credit adjustment for returned goods",
"PONUMBER": "",
"TERMNAME": "",
"TERMKEY": "",
"TERMVALUE": "",
"WHENCREATED": "2024-01-15",
"WHENPOSTED": "2024-01-15",
"WHENDUE": "",
"WHENPAID": "",
"BASECURR": "USD",
"CURRENCY": "USD",
"EXCH_RATE_DATE": "",
"EXCH_RATE_TYPE_ID": "",
"EXCHANGE_RATE": "",
"TOTALENTERED": "-250.00",
"TOTALSELECTED": "0",
"TOTALPAID": "0",
"TOTALDUE": "-250.00",
"TRX_TOTALENTERED": "-250.00",
"TRX_TOTALSELECTED": "0",
"TRX_TOTALPAID": "0",
"TRX_TOTALDUE": "-250.00",
"BILLTOPAYTOCONTACTNAME": "John Doe",
"SHIPTORETURNTOCONTACTNAME": "Jane Smith",
"BILLTOPAYTOKEY": "19714",
"SHIPTORETURNTOKEY": "19715",
"LOCATIONID": "100",
"LOCATIONNAME": "Main Office",
"LOCATIONKEY": "36",
"DEPARTMENTID": "SALES",
"DEPARTMENTNAME": "Sales Department",
"DEPARTMENTKEY": "42",
"PROJECTID": "",
"PROJECTNAME": "",
"PROJECTKEY": "",
"CLASSID": "",
"CLASSNAME": "",
"CLASSKEY": "",
"CONTRACTID": "",
"CONTRACTNAME": "",
"CONTRACTKEY": "",
"SUPDOCID": "",
"ADJUSTMENTNO": "ADJ-2024-001",
"ACTION": "Credit",
"INVOICEKEY": "4774",
"INVOICENO": "INV-2024-001",
"WHENMODIFIED": "2024-01-15T11:15:30Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"MEGAENTITYKEY": "36",
"MEGAENTITYID": "entity",
"MEGAENTITYNAME": "Entity Name",
"ITEMS": [
{
"RECORDNO": "12456",
"ACCOUNTNO": "4000",
"ACCOUNTTITLE": "Sales Revenue",
"AMOUNT": "-250.00",
"MEMO": "Credit for defective items",
"LOCATIONID": "100",
"DEPARTMENTID": "SALES",
"PROJECTID": "",
"CUSTOMERID": "C-01234",
"CLASSID": "",
"CONTRACTID": ""
}
]
}
]
}
}
Get AR Adjustment Line
Retrieve a single AR Adjustment Line. | key: getARAdjustmentLine
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "e2f3a4b5-6c7d-8e9f-0a1b-2c3d4e5f6a7b",
"_listType": "ARADJUSTMENTITEM",
"_count": 1,
"_data": [
{
"RECORDNO": "12456",
"RECORDKEY": "12456",
"ARADJUSTMENTKEY": "8652",
"ADJUSTMENTNO": "ADJ-2024-001",
"LINEITEMKEY": "12456",
"GLACCOUNTNO": "4000",
"GLACCOUNTKEY": "256",
"GLACCOUNTTITLE": "Sales Revenue",
"ACCOUNTLABEL": "",
"ACCOUNTLABELKEY": "",
"AMOUNT": "-250.00",
"TRX_AMOUNT": "-250.00",
"CURRENCY": "USD",
"EXCHRATEDATE": "",
"EXCHRATETYPE": "",
"EXCHRATE": "",
"MEMO": "Credit for defective items",
"LOCATIONID": "100",
"LOCATIONNAME": "Main Office",
"LOCATIONKEY": "36",
"DEPARTMENTID": "SALES",
"DEPARTMENTNAME": "Sales Department",
"DEPARTMENTKEY": "42",
"PROJECTID": "",
"PROJECTNAME": "",
"PROJECTKEY": "",
"CUSTOMERID": "C-01234",
"CUSTOMERNAME": "Acme Corporation",
"CUSTOMERKEY": "12499",
"VENDORID": "",
"VENDORNAME": "",
"VENDORKEY": "",
"EMPLOYEEID": "",
"EMPLOYEENAME": "",
"EMPLOYEEKEY": "",
"ITEMID": "",
"ITEMNAME": "",
"ITEMKEY": "",
"CLASSID": "",
"CLASSNAME": "",
"CLASSKEY": "",
"CONTRACTID": "",
"CONTRACTNAME": "",
"CONTRACTKEY": "",
"WAREHOUSEID": "",
"WAREHOUSENAME": "",
"WAREHOUSEKEY": "",
"STATUS": "active",
"WHENMODIFIED": "2024-01-15T11:15:30Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43"
}
]
}
}
Get AR Advance
Retrieve a single AR Advance. | key: getARAdvance
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "f3a4b5c6-7d8e-9f0a-1b2c-3d4e5f6a7b8c",
"_listType": "ARADVANCE",
"_count": 1,
"_data": [
{
"RECORDNO": "9834",
"RECORDKEY": "9834",
"CUSTOMERID": "C-01234",
"CUSTOMERNAME": "Acme Corporation",
"CUSTOMERKEY": "12499",
"PAYMENTDATE": "2024-01-10",
"RECEIPTDATE": "2024-01-10",
"PAYMENTMETHOD": "Check",
"FINANCIALENTITY": "Bank of America",
"FINANCIALENTITYKEY": "15",
"UNDEPOSITEDACCOUNTNO": "1200",
"UNDEPOSITEDACCOUNTKEY": "45",
"BASECURR": "USD",
"CURRENCY": "USD",
"EXCH_RATE_DATE": "",
"EXCH_RATE_TYPE_ID": "",
"EXCHANGE_RATE": "",
"TOTALENTERED": "10000.00",
"TOTALSELECTED": "0",
"TOTALAPPLIED": "2500.00",
"TOTALUNAPPLIED": "7500.00",
"TRX_TOTALENTERED": "10000.00",
"TRX_TOTALSELECTED": "0",
"TRX_TOTALAPPLIED": "2500.00",
"TRX_TOTALUNAPPLIED": "7500.00",
"STATE": "Posted",
"RAWSTATE": "A",
"DESCRIPTION": "Advance payment for Q1 services",
"REFERENCENO": "CHK-2024-0015",
"BANKACCOUNTID": "1000",
"BANKACCOUNTKEY": "25",
"DEPOSITDATE": "2024-01-11",
"REFID": "",
"LOCATIONID": "100",
"LOCATIONNAME": "Main Office",
"LOCATIONKEY": "36",
"DEPARTMENTID": "SALES",
"DEPARTMENTNAME": "Sales Department",
"DEPARTMENTKEY": "42",
"PROJECTID": "",
"PROJECTNAME": "",
"PROJECTKEY": "",
"CLASSID": "",
"CLASSNAME": "",
"CLASSKEY": "",
"CONTRACTID": "",
"CONTRACTNAME": "",
"CONTRACTKEY": "",
"WHENCREATED": "2024-01-10",
"WHENMODIFIED": "2024-01-10T16:45:20Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"MEGAENTITYKEY": "36",
"MEGAENTITYID": "entity",
"MEGAENTITYNAME": "Entity Name",
"ITEMS": [
{
"RECORDNO": "23567",
"ACCOUNTNO": "1200",
"ACCOUNTKEY": "45",
"ACCOUNTTITLE": "Undeposited Funds",
"AMOUNT": "10000.00",
"TRX_AMOUNT": "10000.00",
"MEMO": "Q1 advance payment",
"LOCATIONID": "100",
"DEPARTMENTID": "SALES",
"PROJECTID": "",
"CUSTOMERID": "C-01234",
"CLASSID": "",
"CONTRACTID": ""
}
]
}
]
}
}
Get AR Payment
Retrieve a single AR Payment. | key: getArPayment
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "9f54dc6e-ddcc-43ed-a979-eed3599b1234",
"_listType": "ARPYMT",
"_count": 0,
"_data": []
}
}
Get Bill
Retrieve a single bill. | key: getBill
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "9b7a9dc1-be4a-471a-95a6-6e8e68dc1234",
"_listType": "APBILL",
"_count": 1,
"_data": [
{
"RECORDNO": "2746",
"RECORDTYPE": "pi",
"RECORDID": "11111",
"CONTACTTAXGROUP": "",
"FINANCIALENTITY": "",
"STATE": "Posted",
"RAWSTATE": "A",
"VENDORID": "V-01234",
"VENDORNAME": "Changed Name",
"VENDORKEY": "1234",
"FORM1099TYPE": "",
"FORM1099BOX": "",
"VENDTYPE1099TYPE": "",
"TRX_ENTITYDUE": "1902.28",
"DOCNUMBER": "",
"DESCRIPTION": "",
"DESCRIPTION2": "",
"TERMNAME": "",
"TERMKEY": "",
"TERMVALUE": "",
"WHENCREATED": "2023-12-06",
"WHENPOSTED": "2023-12-06",
"WHENDISCOUNT": "",
"WHENDUE": "2023-12-06",
"WHENPAID": "",
"RECPAYMENTDATE": "",
"PAYMENTPRIORITY": "normal",
"ONHOLD": "false",
"BASECURR": "USD",
"CURRENCY": "USD",
"EXCH_RATE_DATE": "",
"EXCH_RATE_TYPE_ID": "",
"EXCHANGE_RATE": "",
"TOTALENTERED": "100.12",
"TOTALSELECTED": "0",
"TOTALPAID": "0",
"TOTALDUE": "100.12",
"TRX_TOTALENTERED": "100.12",
"TRX_TOTALSELECTED": "0",
"TRX_TOTALPAID": "0",
"TRX_TOTALDUE": "100.12",
"BILLTOPAYTOCONTACTNAME": "A vendor(VV-01234)",
"SHIPTORETURNTOCONTACTNAME": "A vendor(VV-01234)",
"BILLTOPAYTOKEY": "22135",
"SHIPTORETURNTOKEY": "22135",
"PRBATCH": "Bills - locationId: 2024/01/02 13:26:29:633 Batch",
"PRBATCHKEY": "2092",
"MODULEKEY": "3.AP",
"DOCUMENT_DOCPARID": "",
"SCHOPKEY": "",
"SYSTEMGENERATED": "F",
"AUWHENCREATED": "2024-01-02T18:26:29Z",
"WHENMODIFIED": "2024-01-02T18:37:32Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"DUE_IN_DAYS": "36",
"PAYTO": {
"TAXGROUP": {
"NAME": "",
"RECORDNO": ""
},
"TAXID": ""
},
"INCLUSIVETAX": "false",
"TAXSOLUTIONKEY": "",
"TAXSOLUTIONID": "",
"SHOWMULTILINETAX": "",
"TAXMETHOD": "",
"RETAINAGEPERCENTAGE": "",
"TRX_TOTALRETAINED": "0",
"TRX_TOTALRELEASED": "0",
"TOTALRETAINED": "0",
"SUPDOCID": "",
"SUPDOCKEY": "",
"BILLBACKTEMPLATE": "",
"USERID": "TestUser",
"CREATEDUSERID": "TestUser",
"DOCSOURCE": "",
"UPLOADSTATUS": "",
"RECIPIENTEMAIL": "",
"SENDEREMAIL": "",
"RETAINAGERELEASED": "false",
"MEGAENTITYKEY": "36",
"MEGAENTITYID": "locationId",
"MEGAENTITYNAME": "Location Name",
"BDC_BILLID": "",
"BDC_ORGID": "",
"BDC_URL_PREFIX": "",
"BUILDOPSUPDATE": "false",
"BO_REC": "",
"EXTERNALURL": "",
"EXCHRATEDATE": "",
"EXCHRATETYPE": "",
"EXCHRATE": "",
"PAYTOCONTACTNAME": "A vendor(VV-01234)",
"RETURNTOCONTACTNAME": "A vendor(VV-01234)",
"APBILLITEMS": {
"apbillitem": {
"RECORDNO": "12996",
"RECORDKEY": "2746",
"ACCOUNTKEY": "261",
"ACCOUNTNO": "10000",
"OFFSETACCOUNTKEY": "65",
"OFFSETGLACCOUNTNO": "20000",
"OFFSETGLACCOUNTTITLE": "Accounts Payable",
"ACCOUNTTITLE": "Account",
"ACCOUNTLABELKEY": "",
"ACCOUNTLABEL": "",
"PRENTRYOFFSETACCOUNTKEY": "65",
"PRENTRYOFFSETACCOUNTNO": "20000",
"ENTRY_DATE": "2023-12-06",
"AMOUNT": "100.12",
"TRX_AMOUNT": "100.12",
"DEPT": "",
"DEPARTMENTID": "",
"DEPARTMENTNAME": "",
"LOCATION": "36",
"LOCATIONID": "locationId",
"LOCATIONNAME": "Location Name",
"ENTRYDESCRIPTION": "Line 1 of my bill",
"EXCH_RATE_DATE": "",
"EXCH_RATE_TYPE_ID": "",
"EXCHANGE_RATE": "1",
"ALLOCATION": "",
"ALLOCATIONKEY": "",
"FORM1099": "false",
"LINEITEM": "T",
"LINE_NO": "1",
"CURRENCY": "USD",
"BASECURR": "USD",
"TOTALPAID": "0",
"TRX_TOTALPAID": "0",
"TOTALSELECTED": "0",
"TRX_TOTALSELECTED": "0",
"BILLABLE": "false",
"BILLED": "false",
"RELEASETOPAY": "false",
"PARENTENTRY": "",
"BASELOCATION": "36",
"STATE": "A",
"RECORDTYPE": "pi",
"FORM1099TYPE": "",
"FORM1099BOX": "",
"DETAILID": "",
"ISTAX": "false",
"DETAILKEY": "",
"WHENCREATED": "2024-01-02T18:26:29Z",
"WHENMODIFIED": "2024-01-02T18:37:32Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"TAXRATE": "",
"RETAINAGEPERCENTAGE": "",
"TRX_AMOUNTRETAINED": "",
"AMOUNTRETAINED": "",
"HASRETAINAGE": "false",
"TRX_AMOUNTRELEASED": "",
"RETAINAGERELEASED": "false",
"RETAINAGE_OFFSETACCOUNTKEY": "",
"RETAINAGE_OFFSETGLACCOUNTNO": "",
"RETAINAGE_OFFSETGLACCOUNTTITLE": "",
"SUBTOTAL": "",
"PARENTTAXENTRY": "",
"PARTIALEXEMPT": "false",
"PAYMENTTAXCAPTURE": "false",
"GLOFFSET": "1",
"RECORDID": "11111",
"NAMEOFACQUIREDASSET": "",
"INCLUDETAXINASSETCOST": "false",
"ITEM_DESC": "",
"DESCRIPTION": "",
"JOB": "",
"BUILDOPSLINK": "",
"GLDIMDIVISION": "10030",
"PROJECTDIMKEY": "",
"PROJECTID": "",
"PROJECTNAME": "",
"CUSTOMERDIMKEY": "",
"CUSTOMERID": "",
"CUSTOMERNAME": "",
"VENDORDIMKEY": "",
"VENDORID": "",
"VENDORNAME": "",
"EMPLOYEEDIMKEY": "",
"EMPLOYEEID": "",
"EMPLOYEENAME": "",
"ITEMDIMKEY": "",
"ITEMID": "",
"ITEMNAME": "",
"CLASSDIMKEY": "",
"CLASSID": "",
"CLASSNAME": "",
"RGLDIM101000000010217_10067": "10030",
"GLACCOUNTNO": "10000",
"GLACCOUNTTITLE": "Account",
"ENTRYEXCHRATEDATE": "",
"ENTRYEXCHRATETYPE": "",
"ENTRYEXCHRATE": "1",
"ENTRYCURRENCY": "USD",
"ENTRYBASECURRENCY": "USD"
}
},
"VENDOR": "V-01234--Changed Name"
}
]
}
}
Get Contact
Retrieve a single contact. | key: getContact
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "b53e1bee-6ab4-4ba5-955d-731ffcb51234",
"_listType": "CONTACT",
"_count": 1,
"_data": [
{
"RECORDNO": "12345",
"VERSIONKEY": "22115",
"CONTACTNAME": "A Contact Name Two",
"COMPANYNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"LASTNAME": "",
"INITIAL": "",
"PRINTAS": "Testing",
"TAXABLE": "false",
"TAXGROUP": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "true",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "United States",
"COUNTRYCODE": "US",
"LATITUDE": "",
"LONGITUDE": ""
},
"STATUS": "active",
"PRICESCHEDULE": "",
"DISCOUNT": "",
"PRICELIST": "",
"PRICELISTKEY": "",
"TAXID": "",
"SIRET": "",
"TAXGROUPKEY": "",
"TAXSOLUTIONKEY": "",
"TAXSOLUTIONID": "",
"TAXSCHEDULE": "",
"PRICESCHEDULEKEY": "",
"WHENCREATED": "2023-12-04T01:35:30Z",
"WHENMODIFIED": "2023-12-04T01:35:30Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"MEGAENTITYKEY": "",
"MEGAENTITYID": "",
"MEGAENTITYNAME": ""
}
]
}
}
Get Customer
Retrieve a single customer. | key: getCustomer
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "37882748-090a-4131-a6f3-d411d9c22556",
"_listType": "CUSTOMER",
"_count": 1,
"_data": [
{
"RECORDNO": "12499",
"CUSTOMERID": "C-01234",
"NAME": "John",
"ENTITY": "CC-01234",
"PARENTKEY": "",
"PARENTID": "",
"PARENTNAME": "",
"DISPLAYCONTACT": {
"CONTACTNAME": "John(CC-01234)",
"COMPANYNAME": "Company",
"PREFIX": "Test",
"FIRSTNAME": "John",
"LASTNAME": "Doe",
"INITIAL": "Middle",
"PRINTAS": "Print",
"TAXABLE": "true",
"TAXGROUP": "",
"TAXSOLUTIONKEY": "",
"TAXSOLUTIONID": "",
"TAXSCHEDULE": "",
"TAXID": "",
"SIRET": "",
"PHONE1": "5241234545",
"PHONE2": "5241234545",
"CELLPHONE": "5241234545",
"PAGER": "1",
"FAX": "5241234123",
"TAXIDVALIDATIONDATE": "",
"GSTREGISTERED": "",
"TAXCOMPANYNAME": "",
"TAXADDRESS": "",
"EMAIL1": "user@example.com",
"EMAIL2": "user@example.com",
"URL1": "https://www.example.com",
"URL2": "https://www.example.com",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "Address 1",
"ADDRESS2": "Address 2",
"ADDRESS3": "",
"CITY": "City",
"STATE": "City",
"ZIP": "12100",
"COUNTRY": "United States",
"COUNTRYCODE": "US",
"LATITUDE": "",
"LONGITUDE": ""
},
"STATUS": "active"
},
"TERMNAME": "",
"TERMVALUE": "",
"CUSTREPID": "",
"CUSTREPNAME": "",
"RESALENO": "",
"TAXID": "",
"CREDITLIMIT": "1.23",
"TOTALDUE": "0",
"COMMENTS": "",
"ACCOUNTLABEL": "",
"ARACCOUNT": "",
"ARACCOUNTTITLE": "",
"LAST_INVOICEDATE": "",
"LAST_STATEMENTDATE": "",
"DELIVERY_OPTIONS": "Print",
"TERRITORYID": "",
"TERRITORYNAME": "",
"SHIPPINGMETHOD": "",
"CUSTTYPE": "",
"GLGRPKEY": "",
"GLGROUP": "",
"PRICESCHEDULE": "",
"DISCOUNT": "",
"PRICELIST": "",
"VSOEPRICELIST": "",
"CURRENCY": "",
"CONTACTINFO": {
"CONTACTNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"INITIAL": "",
"LASTNAME": "",
"COMPANYNAME": "",
"PRINTAS": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "",
"COUNTRYCODE": ""
}
},
"SHIPTO": {
"CONTACTNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"INITIAL": "",
"LASTNAME": "",
"COMPANYNAME": "",
"PRINTAS": "",
"TAXABLE": "false",
"TAXGROUP": "",
"TAXSOLUTIONKEY": "",
"TAXSOLUTIONID": "",
"TAXSCHEDULE": "",
"TAXID": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "",
"COUNTRYCODE": ""
}
},
"BILLTO": {
"CONTACTNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"INITIAL": "",
"LASTNAME": "",
"COMPANYNAME": "",
"PRINTAS": "",
"TAXABLE": "false",
"TAXGROUP": "",
"TAXSOLUTIONKEY": "",
"TAXSOLUTIONID": "",
"TAXSCHEDULE": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "",
"COUNTRYCODE": ""
}
},
"STATUS": "active",
"ONETIME": "false",
"CUSTMESSAGEID": "",
"ONHOLD": "false",
"PRCLST_OVERRIDE": "C",
"OEPRCLSTKEY": "",
"OEPRICESCHEDKEY": "",
"ENABLEONLINECARDPAYMENT": "true",
"ENABLEONLINEACHPAYMENT": "true",
"VSOEPRCLSTKEY": "",
"WHENMODIFIED": "2024-01-10T23:05:51Z",
"ARINVOICEPRINTTEMPLATEID": "",
"OEQUOTEPRINTTEMPLATEID": "",
"OEORDERPRINTTEMPLATEID": "",
"OELISTPRINTTEMPLATEID": "",
"OEINVOICEPRINTTEMPLATEID": "",
"OEADJPRINTTEMPLATEID": "",
"OEOTHERPRINTTEMPLATEID": "",
"WHENCREATED": "2024-01-10T23:05:51Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"OBJECTRESTRICTION": "Unrestricted",
"DISPLAYCONTACTKEY": "19714",
"CONTACTKEY": "",
"SHIPTOKEY": "",
"BILLTOKEY": "",
"CUSTREPKEY": "",
"SHIPVIAKEY": "",
"TERRITORYKEY": "",
"TERMSKEY": "",
"ACCOUNTLABELKEY": "",
"ACCOUNTKEY": "",
"CUSTTYPEKEY": "",
"PRICESCHEDULEKEY": "",
"OFFSETGLACCOUNTNO": "",
"OFFSETGLACCOUNTNOTITLE": "",
"ADVBILLBY": "",
"ADVBILLBYTYPE": "",
"SUPDOCID": "",
"RETAINAGEPERCENTAGE": "",
"EMAILOPTIN": "false",
"MEGAENTITYKEY": "36",
"MEGAENTITYID": "entity",
"MEGAENTITYNAME": "Entity Name",
"LOCATIONKEY": "36",
"RARNOTES": "",
"HIDEDISPLAYCONTACT": "true",
"SFORCEKEY": ""
}
]
}
}
Get Invoice
Retrieve a single invoice. | key: getInvoice
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "a5b2c8d1-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
"_listType": "ARINVOICE",
"_count": 1,
"_data": [
{
"RECORDNO": "4774",
"RECORDTYPE": "ri",
"RECORDID": "INV-2024-001",
"CUSTOMERID": "C-01234",
"CUSTOMERNAME": "Acme Corporation",
"CUSTOMERKEY": "12499",
"STATE": "Posted",
"RAWSTATE": "A",
"DOCNUMBER": "INV-2024-001",
"DESCRIPTION": "Professional Services - January 2024",
"PONUMBER": "PO-5678",
"TERMNAME": "Net 30",
"TERMKEY": "15",
"TERMVALUE": "30",
"WHENCREATED": "2024-01-15",
"WHENPOSTED": "2024-01-15",
"WHENDUE": "2024-02-14",
"WHENPAID": "",
"BASECURR": "USD",
"CURRENCY": "USD",
"EXCH_RATE_DATE": "",
"EXCH_RATE_TYPE_ID": "",
"EXCHANGE_RATE": "",
"TOTALENTERED": "5000.00",
"TOTALSELECTED": "0",
"TOTALPAID": "0",
"TOTALDUE": "5000.00",
"TRX_TOTALENTERED": "5000.00",
"TRX_TOTALSELECTED": "0",
"TRX_TOTALPAID": "0",
"TRX_TOTALDUE": "5000.00",
"BILLTOPAYTOCONTACTNAME": "John Doe",
"SHIPTORETURNTOCONTACTNAME": "Jane Smith",
"BILLTOPAYTOKEY": "19714",
"SHIPTORETURNTOKEY": "19715",
"CONTACT_CELL_PHONE": "555-0123",
"CONTACT_EMAIL1": "john.doe@example.com",
"CONTACT_PHONE1": "555-0100",
"LOCATIONID": "100",
"LOCATIONNAME": "Main Office",
"LOCATIONKEY": "36",
"DEPARTMENTID": "SALES",
"DEPARTMENTNAME": "Sales Department",
"DEPARTMENTKEY": "42",
"PROJECTID": "",
"PROJECTNAME": "",
"PROJECTKEY": "",
"VENDORID": "",
"VENDORKEY": "",
"EMPLOYEEID": "",
"EMPLOYEEKEY": "",
"CLASSID": "",
"CLASSNAME": "",
"CLASSKEY": "",
"CONTRACTID": "",
"CONTRACTNAME": "",
"CONTRACTKEY": "",
"WAREHOUSEID": "",
"WAREHOUSEKEY": "",
"TRX_TOTAL_OPEN": "5000.00",
"SUPDOCID": "",
"TAXSOLUTIONID": "",
"TAXSOLUTIONKEY": "",
"PAYMENTPRIORITY": "Normal",
"ONHOLD": "false",
"RECPAYMENTDATE": "",
"WHENMODIFIED": "2024-01-15T10:30:00Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"MEGAENTITYKEY": "36",
"MEGAENTITYID": "entity",
"MEGAENTITYNAME": "Entity Name",
"ITEMS": [
{
"RECORDNO": "10234",
"ITEMID": "SERVICE-001",
"ITEMNAME": "Consulting Services",
"ITEMDESC": "Professional consulting hours",
"QUANTITY": "40",
"UNIT": "hours",
"PRICE": "125.00",
"AMOUNT": "5000.00",
"TAXABLE": "true",
"TAXGROUP": "",
"LOCATIONID": "100",
"DEPARTMENTID": "SALES",
"PROJECTID": "",
"CUSTOMERID": "C-01234",
"VENDORID": "",
"EMPLOYEEID": "",
"CLASSID": "",
"CONTRACTID": "",
"WAREHOUSEID": ""
}
]
}
]
}
}
Get Project
Retrieve a project by record number. | key: getProject
| Input | Notes | Example |
|---|---|---|
| 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. | 12345 |
{
"data": {
"RECORDNO": "2",
"PROJECTID": "21-1234",
"NAME": "Sample Project",
"DESCRIPTION": "",
"CURRENCY": "USD",
"PROJECTCATEGORY": "Contract",
"PROJECTSTATUSKEY": "",
"PROJECTSTATUS": "",
"PREVENTTIMESHEET": "false",
"PREVENTEXPENSE": "false",
"PREVENTAPPO": "false",
"PREVENTGENINVOICE": "false",
"STATUS": "active",
"BEGINDATE": "2019-01-01",
"ENDDATE": "2022-12-31",
"BUDGETAMOUNT": "",
"CONTRACTAMOUNT": "",
"ACTUALAMOUNT": "",
"BUDGETQTY": "",
"ESTQTY": "",
"ACTUALQTY": "",
"APPROVEDQTY": "",
"REMAININGQTY": "",
"PERCENTCOMPLETE": "",
"OBSPERCENTCOMPLETE": "0",
"BILLINGTYPE": "",
"SONUMBER": "",
"PONUMBER": "",
"POAMOUNT": "",
"PQNUMBER": "",
"SFDCKEY": "",
"QARROWKEY": "",
"OAKEY": "",
"PARENTKEY": "",
"PARENTID": "",
"PARENTNAME": "",
"INVOICEWITHPARENT": "false",
"CUSTOMERKEY": "",
"CUSTOMERID": "",
"CUSTOMERNAME": "",
"SALESCONTACTKEY": "",
"SALESCONTACTID": "",
"SALESCONTACTNAME": "",
"PROJECTTYPEKEY": "",
"PROJECTTYPE": "",
"MANAGERKEY": "",
"MANAGERID": "",
"MANAGERCONTACTNAME": "",
"PROJECTDEPTKEY": "",
"DEPARTMENTID": "",
"DEPARTMENTNAME": "",
"PROJECTLOCATIONKEY": "3",
"LOCATIONID": "",
"LOCATIONNAME": "",
"CONTACTINFO": {
"CONTACTNAME": ""
},
"SHIPTO": {
"CONTACTNAME": ""
},
"BILLTO": {
"CONTACTNAME": ""
},
"TERMSKEY": "",
"TERMNAME": "",
"DOCNUMBER": "",
"CUSTUSERKEY": "",
"CUSTUSERID": "",
"WHENCREATED": "2021-02-09T15:50:29Z",
"WHENMODIFIED": "2021-03-01T16:33:10Z",
"CREATEDBY": "4",
"MODIFIEDBY": "4",
"BUDGETEDCOST": "",
"CLASSID": "",
"CLASSNAME": "",
"CLASSKEY": "",
"USERRESTRICTIONS": "System Default",
"BILLABLEEXPDEFAULT": "false",
"BILLABLEAPPODEFAULT": "false",
"BUDGETID": "",
"BUDGETKEY": "",
"BILLINGRATE": "",
"BILLINGPRICING": "Billing rate",
"EXPENSERATE": "0",
"EXPENSEPRICING": "Cost plus fee",
"POAPRATE": "0",
"POAPPRICING": "Cost plus fee",
"CONTACTKEY": "",
"SHIPTOKEY": "",
"BILLTOKEY": "",
"INVOICEMESSAGE": "",
"INVOICECURRENCY": "",
"BILLINGOVERMAX": "Do nothing",
"EXCLUDEEXPENSES": "false",
"CONTRACTKEY": "",
"CONTRACTID": "",
"ROOTPARENTKEY": "2",
"ROOTPARENTID": "21-1234",
"ROOTPARENTNAME": "Sample Project",
"MEGAENTITYKEY": "",
"MEGAENTITYID": "",
"MEGAENTITYNAME": ""
}
}
Get Vendor
Retrieve a single vendor. | key: getVendor
| Input | Notes | Example |
|---|---|---|
| Connection | The Sage Intacct connection to use. | |
| Field | Field to retrieve, use * for all fields | * |
| Record No | The unique record number identifier | 12345 |
{
"data": {
"_status": "success",
"_functionName": "read",
"_controlId": "a3f5bbad-6f3f-417d-a8fc-df1646581234",
"_listType": "VENDOR",
"_count": 1,
"_data": [
{
"RECORDNO": "12345",
"VENDORID": "V-12345",
"NAME": "A vendor",
"NAME1099": "",
"PARENTKEY": "",
"PARENTID": "",
"PARENTNAME": "",
"DISPLAYCONTACT": {
"CONTACTNAME": "A vendor(VV-12345)",
"COMPANYNAME": "Example Company",
"PREFIX": "",
"FIRSTNAME": "",
"LASTNAME": "",
"INITIAL": "",
"PRINTAS": "Example",
"TAXABLE": "false",
"TAXGROUP": "",
"TAXSOLUTIONKEY": "",
"TAXSOLUTIONID": "",
"TAXSCHEDULE": "",
"TAXID": "",
"SIRET": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"TAXIDVALIDATIONDATE": "",
"GSTREGISTERED": "",
"TAXCOMPANYNAME": "",
"TAXADDRESS": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "true",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "United States",
"COUNTRYCODE": "US",
"LATITUDE": "",
"LONGITUDE": ""
},
"STATUS": "active"
},
"ENTITY": "VV-12345",
"TERMNAME": "",
"TERMVALUE": "",
"VENDORACCOUNTNO": "",
"TAXID": "",
"CREDITLIMIT": "15.4",
"TOTALDUE": "0",
"BILLINGTYPE": "openitem",
"VENDTYPE": "",
"VENDTYPE1099TYPE": "",
"GLGROUP": "",
"PRICESCHEDULE": "",
"DISCOUNT": "",
"PRICELIST": "",
"COMMENTS": "",
"ACCOUNTLABEL": "",
"APACCOUNT": "",
"APACCOUNTTITLE": "",
"FORM1099TYPE": "",
"FORM1099BOX": "",
"PAYMENTPRIORITY": "Normal",
"CONTACTINFO": {
"CONTACTNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"INITIAL": "",
"LASTNAME": "",
"COMPANYNAME": "",
"PRINTAS": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "",
"COUNTRYCODE": ""
}
},
"PAYTO": {
"CONTACTNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"INITIAL": "",
"LASTNAME": "",
"COMPANYNAME": "",
"PRINTAS": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "",
"COUNTRYCODE": ""
},
"TAXGROUP": "",
"TAXSOLUTIONKEY": "",
"TAXSOLUTIONID": "",
"TAXSCHEDULE": "",
"TAXID": ""
},
"RETURNTO": {
"CONTACTNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"INITIAL": "",
"LASTNAME": "",
"COMPANYNAME": "",
"PRINTAS": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "",
"COUNTRYCODE": ""
}
},
"STATUS": "inactive",
"STATE": "A",
"PAYDATEVALUE": "",
"ONETIME": "false",
"ONHOLD": "false",
"WHENMODIFIED": "2024-01-11T00:48:17Z",
"ISOWNER": "false",
"DONOTCUTCHECK": "false",
"ALWAYSCREATEBILL": "false",
"OWNER": {
"EQGLACCOUNT": "",
"EQGLACCOUNTLABEL": "",
"HOLDDIST": "",
"ACCOUNTLABEL": {
"LABEL": ""
}
},
"CURRENCY": "",
"PYMTCOUNTRYCODE": "",
"PYMTCURRENCY": "",
"FILEPAYMENTSERVICE": "NONE",
"ACHENABLED": "false",
"WIREENABLED": "false",
"CHECKENABLED": "false",
"ACHBANKROUTINGNUMBER": "",
"ACHACCOUNTNUMBER": "",
"ACHACCOUNTTYPE": "",
"ACHREMITTANCETYPE": "",
"WIREBANKNAME": "",
"WIREBANKROUTINGNUMBER": "",
"WIREACCOUNTNUMBER": "",
"WIREACCOUNTTYPE": "",
"PMPLUSREMITTANCETYPE": "",
"PMPLUSEMAIL": "",
"PMPLUSFAX": "",
"DISPLAYTERMDISCOUNT": "false",
"OEPRCLSTKEY": "",
"DISPLOCACCTNOCHECK": "false",
"WHENCREATED": "2024-01-11T00:48:15Z",
"CREATEDBY": "43",
"MODIFIEDBY": "43",
"PAYMENTNOTIFY": "false",
"PAYMETHODKEY": "",
"OBJECTRESTRICTION": "",
"MERGEPAYMENTREQ": "false",
"DISPLAYCONTACTKEY": "19716",
"PRIMARYCONTACTKEY": "",
"PAYTOKEY": "",
"RETURNTOKEY": "",
"ACCOUNTLABELKEY": "",
"ACCOUNTKEY": "",
"VENDTYPEKEY": "",
"GLGRPKEY": "",
"TERMSKEY": "",
"VENDORACCTNOKEY": "",
"PAYMETHODREC": "",
"OUTSOURCECHECK": "false",
"OUTSOURCECHECKSTATE": "",
"OUTSOURCEACH": "false",
"OUTSOURCEACHSTATE": "",
"OUTSOURCECARD": "false",
"OUTSOURCECARDOVERRIDE": "false",
"CARDSTATE": "",
"VENDORACHACCOUNTID": "",
"VENDORACCOUNTOUTSOURCEACH": "",
"OFFSETGLACCOUNTNO": "",
"OFFSETGLACCOUNTNOTITLE": "",
"CONTACTTO1099": {
"CONTACTNAME": "",
"PREFIX": "",
"FIRSTNAME": "",
"INITIAL": "",
"LASTNAME": "",
"COMPANYNAME": "",
"PRINTAS": "",
"PHONE1": "",
"PHONE2": "",
"CELLPHONE": "",
"PAGER": "",
"FAX": "",
"EMAIL1": "",
"EMAIL2": "",
"URL1": "",
"URL2": "",
"VISIBLE": "false",
"MAILADDRESS": {
"ADDRESS1": "",
"ADDRESS2": "",
"ADDRESS3": "",
"CITY": "",
"STATE": "",
"ZIP": "",
"COUNTRY": "",
"COUNTRYCODE": ""
}
},
"CONTACTKEY1099": "",
"SUPDOCID": "",
"VENDOR_AMEX_ORGANIZATION_ID": "",
"VENDOR_AMEX_ORG_ADDRESS_ID": "",
"VENDOR_AMEX_CD_AFFILIATE_ID": "",
"VENDOR_AMEX_CARD_AFFILIATE_ID": "",
"AMEX_BANK_ACCOUNT_ID": "",
"AMEX_BANK_ACCOUNT_ADDRESS_ID": "",
"RETAINAGEPERCENTAGE": "",
"ISINDIVIDUAL": "false",
"PROVIDERSTATUS": "false",
"WHENLASTBILLED": "",
"WHENLASTPAID": "",
"PROVIDERMISMATCH": "false",
"ENABLE_TPAR": "false",
"NAMETPAR": "",
"MEGAENTITYKEY": "36",
"MEGAENTITYID": "entity",
"MEGAENTITYNAME": "Entity Name",
"HIDEDISPLAYCONTACT": "false"
}
]
}
}
Query and List Records
Lists specified criteria based on a query. | key: queryAndList
| Input | Notes | Example |
|---|---|---|
| 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. | VENDOR |
| Query | Query filter expression to filter the records | VENDOR.CREDITLIMIT > 10000 |
{
"data": [
{
"RECORDNO": "1234",
"CUSTOMERNAME": "Test Client"
},
{
"RECORDNO": "1235",
"CUSTOMERNAME": "Another Test Client"
}
]
}
Raw Request
Send raw HTTP request to Sage Intacct | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| 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, 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. | |
| 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 |
| Header | A list of headers to send with the request. Sage Intacct API is XML based. Content-Type: 'application/xml' header is already added. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Response Type | The type of data you expect in the response. You can request json or xml data. | json |
| 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 |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"example"
],
"controlid": [
"1705003571234"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"UtilizeCore"
],
"companyid": [
"example-imp"
],
"locationid": [
"example-location"
],
"sessiontimestamp": [
"2024-01-15T16:00:00+00:00"
],
"sessiontimeout": [
"2024-01-16T00:00:00+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"query"
],
"controlid": [
"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a"
],
"data": [
{
"$": {
"listtype": "contact",
"count": "2",
"totalcount": "2",
"numremaining": "0",
"resultId": ""
},
"contact": [
{
"RECORDNO": [
"1234"
],
"CONTACTNAME": [
"John Doe"
],
"COMPANYNAME": [
"Acme Corporation"
],
"FIRSTNAME": [
"John"
],
"LASTNAME": [
"Doe"
],
"EMAIL1": [
"john.doe@example.com"
],
"PHONE1": [
"555-0100"
],
"STATUS": [
"active"
]
},
{
"RECORDNO": [
"1235"
],
"CONTACTNAME": [
"Jane Smith"
],
"COMPANYNAME": [
"Beta Industries"
],
"FIRSTNAME": [
"Jane"
],
"LASTNAME": [
"Smith"
],
"EMAIL1": [
"jane.smith@example.com"
],
"PHONE1": [
"555-0200"
],
"STATUS": [
"active"
]
}
]
}
]
}
]
}
]
}
}
}
Update AR Adjustment
Update an existing AR Adjustment. | key: updateARAdjustment
| Input | Notes | Example |
|---|---|---|
| Action | Action. Use Draft or Submit. (Default: Submit) | |
| Additional XML Tags | Additional XML tags that might not be covered by the standard inputs. | |
| Adjustment Number | AR Adjustment ADJUSTMENTNO to update. | |
| AR Adjustment Line Items | AR Adjustment LINEITEMS to update. Each item must be wrapped in <updatelineitem></updatelineitem> or <lineitem></lineitem> tags. | |
| Connection | The Sage Intacct connection to use. | |
| Currency | AR Adjustment CURRENCY to update. | USD |
| Customer ID | AR Adjustment CUSTOMERID to update. | CUST-12345 |
| Date Created | AR Adjustment DATECREATED to update. | 12/06/2023 |
| GL Date Posted | AR Adjustment DATEPOSTED to update. | 12/06/2023 |
| Description | AR Adjustment DESCRIPTION to update. | Office supplies for Q1 2024 |
| Exchange Rate Type | AR Adjustment EXCHRATETYPE to update. | Intacct Daily Rate |
| Invoice Number | AR Adjustment INVOICENO to update. | 1234 |
| Record Number | AR Adjustment RECORDNO of bill to update. | 123 |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"example"
],
"controlid": [
"1705003571234"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"UtilizeCore"
],
"companyid": [
"example-imp"
],
"locationid": [
"example-location"
],
"sessiontimestamp": [
"2024-01-15T14:30:45+00:00"
],
"sessiontimeout": [
"2024-01-15T22:30:45+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"update"
],
"controlid": [
"d9e0f1a2-b3c4-5d6e-7f8a-9b0c1d2e3f4a"
],
"key": [
"8652"
]
}
]
}
]
}
}
}
Update AR Advance
Update an existing AR Advance. | key: updateARAdvance
| Input | Notes | Example |
|---|---|---|
| Additional XML Tags | Additional XML tags that might not be covered by the standard inputs. | |
| AR Advance Items | AR Advance ARADVANCEITEMS to update. <strong>Note:</strong> 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. | |
| Connection | The Sage Intacct connection to use. | |
| Financial Entity | AR Advance FINANCIALENTITY to update. | 1020 |
| Payment Date | AR Advance PAYMENTDATE to update. | 09/12/2021 |
| Payment Method | AR Advance PAYMENTMETHOD to update. | Cash |
| Receipt Date | AR Advance RECEIPTDATE to update. | 09/12/2021 |
| Record No | AR Advance RECORDNO to update. | 12345 |
| Undeposited Account No | AR Advance UNDEPOSITEDACCOUNTNO to update. | 1020 |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"example"
],
"controlid": [
"1705003571234"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"UtilizeCore"
],
"companyid": [
"example-imp"
],
"locationid": [
"example-location"
],
"sessiontimestamp": [
"2024-01-10T17:30:15+00:00"
],
"sessiontimeout": [
"2024-01-11T01:30:15+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"update"
],
"controlid": [
"b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e"
],
"key": [
"9834"
]
}
]
}
]
}
}
}
Update Contact
Update an existing contact. | key: updateContact
| Input | Notes | Example |
|---|---|---|
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Address Line 1 | First line's address | 123 Main St. |
| Address Line 2 | Second line's address | Suite 400 |
| Cellular Phone Number | Cellular phone number | +1-555-234-5678 |
| City | City name. | New York |
| Company Name | Name of the company | Acme Corporation |
| Connection | The Sage Intacct connection to use. | |
| Contact Name | Full name of the contact | John Doe |
| Contact Tax Group Name | Name of the tax group | Standard Tax Group |
| Country | Country name. | United States |
| Fax Number | Fax number | +1-555-345-6789 |
| First Name | First name | John |
| Last Name | Last name | Doe |
| Middle Name | Middle name | A. |
| Pager Number | Pager number | +1-555-PAGER-01 |
| Prefix | Prefix for the name | Mr. |
| Primary Email Address | Primary email address | john.doe@example.com |
| Primary Phone Number | Primary phone number | +1-555-123-4567 |
| Primary URL | Primary URL | https://www.example.com |
| Print Name As | Determine the format the name should be printed. | John A. Doe |
| Secondary Email Address | Secondary email address | jane.smith@example.com |
| Secondary Phone Number | Secondary phone number | +1-555-987-6543 |
| Secondary URL | Secondary URL | https://www.example.com |
| State/Province | State or province | NY |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Tax ID | Tax identification number (EIN/SSN) | 12-3456789 |
| ZIP/Postal Code | ZIP or postal code. | 10001 |
{
"data": {
"_controlId": "64b091d8-4bd6-4f2e-b175-d90d4e3a1234",
"contactName": "John Doe",
"addressLine1": "123 Main St",
"firstName": "John",
"lastName": "Doe",
"pagerNo": "123",
"taxable": false
}
}
Update Customer
Updates an existing customer in Intacct. The customer is identified by the customer ID. | key: updateCustomer
| Input | Notes | Example |
|---|---|---|
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Address Line 1 | First line's address | 123 Main St. |
| Address Line 2 | Second line's address | Suite 400 |
| Attachments ID | Id of an attachment group of one or more supporting files | ATT-001 |
| Bill To Contact Name | Bill to contact. If blank system will use DISPLAYCONTACT. | Jane Smith |
| Cellular Phone Number | Cellular phone number | +1-555-234-5678 |
| City | City name. | New York |
| Comments | Additional comments | |
| Company Name | Name of the company | Acme Corporation |
| Connection | The Sage Intacct connection to use. | |
| Contact Tax Group Name | Name of the tax group | Standard Tax Group |
| Country | Country name. | United States |
| Credit Limit | Credit limit amount | 50000 |
| 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. | CUST-12345 |
| Customer Name | Customer name | Global Tech Solutions |
| Customer Type ID | Identifier for the type of customer | TYPE-001 |
| Custom Fields | Custom field names and values as defined for this object | |
| Default Currency | Default currency code | USD |
| Default Invoice Message | Default message for invoices | |
| Default Revenue GL Account No | Default AR GL account number | 4000 |
| 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. | |
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all lists. | |
| Fax Number | Fax number | +1-555-345-6789 |
| First Name | First name | John |
| GL Group Name | Name of the GL group | Default GL Group |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | US |
| Last Name | Last name | Doe |
| Middle Name | Middle name | A. |
| Offset AR GL Account No | Offset AR GL account number | 1200 |
| 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. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Pager Number | Pager number | +1-555-PAGER-01 |
| Parent Customer ID | Identifier of the parent customer | CUST-PARENT-001 |
| Payment Term | A previously created payment term | Net 30 |
| Prefix | Prefix for the name | Mr. |
| Primary Contact Name | Primary contact. If blank system will use DISPLAYCONTACT. | John Doe |
| Primary Email Address | Primary email address | john.doe@example.com |
| Primary Phone Number | Primary phone number | +1-555-123-4567 |
| Primary URL | Primary URL | https://www.example.com |
| Print Name As | Determine the format the name should be printed. | John A. Doe |
| Print Option AR Invoice Template Name | Template name for AR invoices | |
| Print Option OE Adjustment Template Name | Template name for OE adjustments | |
| Print Option OE Invoice Template Name | Template name for OE invoices | |
| Print Option OE List Template Name | Template name for OE lists | |
| Print Option OE Order Template Name | Template name for OE orders | |
| Print Option OE Other Template Name | Template name for other OE documents | |
| Print Option OE Quote Template Name | Template name for OE quotes | |
| Resale Number | Resale certificate number for tax-exempt purchases | RSL-123456 |
| Restricted Department | Restricted department IDs. Use if OBJECTRESTRICTION is Restricted | |
| Restricted Location | Restricted location ID. Use if OBJECTRESTRICTION is Restricted | |
| Restriction Type | Type of restriction | |
| Sales Rep Employee ID | Employee ID of the sales representative | EMP-001 |
| Secondary Email Address | Secondary email address | jane.smith@example.com |
| Secondary Phone Number | Secondary phone number | +1-555-987-6543 |
| Secondary URL | Secondary URL | https://www.example.com |
| Shipping Method | Shipping method | FedEx Ground |
| Ship To Contact Name | Ship to contact. If blank system will use DISPLAYCONTACT. | Bob Johnson |
| State/Province | State or province | NY |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Tax ID | Tax identification number (EIN/SSN) | 12-3456789 |
| Territory ID | Identifier for the territory | TERR-001 |
| ZIP/Postal Code | ZIP or postal code. | 10001 |
{
"data": {
"_controlId": "49861154-842a-4d25-ab12-2af79dfc1234",
"customFields": [
[
"fieldName1",
123
],
[
"fieldName2",
"someStringValue"
]
],
"customerId": "C-01234",
"customerName": "John Doe",
"excludedFromContactList": false
}
}
Update Invoice
Updates an invoice. | key: updateInvoice
| Input | Notes | Example |
|---|---|---|
| Attachments ID | Id of an attachment group of one or more supporting files | ATT-001 |
| Base Currency | Base currency code | USD |
| Connection | The Sage Intacct connection to use. | |
| Contact Name | Full name of the contact | John Doe |
| Currency | Transaction currency code | USD |
| 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. | CUST-12345 |
| Custom Fields | Custom field names and values as defined for this object | |
| Date Created | Invoice date creation date | 12/06/2023 |
| Date Due | Due date. Required if not using termname. | 12/06/2023 |
| GL Date Posted | Invoice General Ledger posted date | 12/06/2023 |
| Description | The description of the invoice. | Some description |
| Exchange Rate Date | Exchange rate date for the invoice | 12/06/2023 |
| Exchange Rate | Exchange rate for the invoice. Do not use if Exchange Rate Type is used. | |
| Exchange Rate Type | The exchange rate type. Do not use if exchrate is set. | Intacct Daily Rate |
| Invoice Line Items | To update an existing line use <updatelineitem></updatelineitem> otherwise to create a new line item use <lineitem></lineitem> instead.You can mix types in the array. | |
| Invoice Number | Invoice number | 1234 |
| Record Number | Invoice RECORDNO to update | 123 |
| Reference Number | A reference number for the invoice | 1234 |
| Term Name | Payment term, this should be a previously created term | Net 30 |
{
"data": {
"response": {
"control": [
{
"status": [
"success"
],
"senderid": [
"example"
],
"controlid": [
"1705003571234"
],
"uniqueid": [
"false"
],
"dtdversion": [
"3.0"
]
}
],
"operation": [
{
"authentication": [
{
"status": [
"success"
],
"userid": [
"UtilizeCore"
],
"companyid": [
"example-imp"
],
"locationid": [
"example-location"
],
"sessiontimestamp": [
"2024-01-15T14:22:10+00:00"
],
"sessiontimeout": [
"2024-01-15T22:22:10+00:00"
]
}
],
"result": [
{
"status": [
"success"
],
"function": [
"update_invoice"
],
"controlid": [
"b8c9d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e"
],
"key": [
"4774"
]
}
]
}
]
}
}
}
Update Project
Updates an existing project. | key: updateProject
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that are not covered by the standard inputs. | |
| Connection | The Sage Intacct connection to use. | |
| Invoice with Parent | ||
| Parent Project ID | Parent project ID for the to-be-updated object. | 21-1234 |
| Project Category | Project category for the to-be-updated object. | Contract |
| Project Description | Project description for the to-be-updated object. | This is a sample project |
| Project ID | Project ID to update. | 21-1234 |
| Project Name | Project name for the to-be-updated object. | Sample Project |
| Project Status | Project status for the to-be-updated object. | In Progress |
| Project Type | Project type for the to-be-updated object. | Type 1 |
| Status |
{
"data": {
"RECORDNO": "90320",
"PROJECTID": "21-3457"
}
}
Update Vendor
Updates an existing vendor. | key: updateVendor
| Input | Notes | Example |
|---|---|---|
| ACH Bank Account Class | Business | |
| ACH Bank Account No | 1234567890 | |
| ACH Bank Account Type | Checking | |
| ACH Bank Routing No | 021000021 | |
| ACH Enabled | ||
| Active Status | When true, the record is active and available for use. When false, the record is inactive. | |
| Address Line 1 | First line's address | 123 Main St. |
| Address Line 2 | Second line's address | Suite 400 |
| Attachments ID | Id of an attachment group of one or more supporting files | ATT-001 |
| Cellular Phone Number | Cellular phone number | +1-555-234-5678 |
| City | City name. | New York |
| Comments | Additional comments | |
| Company Name | Name of the company | Acme Corporation |
| Connection | The Sage Intacct connection to use. | |
| Contact Tax Group Name | Name of the tax group | Standard Tax Group |
| Country | Country name. | United States |
| Credit Limit | Credit limit amount | 50000 |
| Custom Fields | Custom field names and values as defined for this object | |
| Default Currency | Default currency code | USD |
| Default Expense GL Account No | 6000 | |
| Do Not Pay | ||
| Excluded From Contact List | When true, this contact will be excluded from contact lists and searches. When false, the contact appears in all lists. | |
| Fax Number | Fax number | +1-555-345-6789 |
| First Name | First name | John |
| Form 1099 Box | 7 | |
| Form 1099 Name | John Doe | |
| Form 1099 Type | MISC | |
| GL Group Name | Name of the GL group | Default GL Group |
| ISO Country Code | ISO country code. When ISO country codes are enabled in a company, both COUNTRY and ISOCOUNTRYCODE must be provided. | US |
| Last Name | Last name | Doe |
| Location Assigned Account No Displayed On Check Stub | ||
| Merge Payment Requests | ||
| Middle Name | Middle name | A. |
| Offset GL Account No | 2000 | |
| 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. | |
| On Hold | When true, the account is placed on hold and transactions are suspended. When false, the account operates normally. | |
| Pager Number | Pager number | +1-555-PAGER-01 |
| Parent Vendor ID | VENDOR-PARENT-001 | |
| Payment Priority | High | |
| Payment Term | A previously created payment term | Net 30 |
| Pay To Contact Name | John Doe | |
| Preferred Payment Method | Check | |
| Prefix | Prefix for the name | Mr. |
| Primary Contact Name | Primary contact. If blank system will use DISPLAYCONTACT. | John Doe |
| Primary Email Address | Primary email address | john.doe@example.com |
| Primary Phone Number | Primary phone number | +1-555-123-4567 |
| Primary URL | Primary URL | https://www.example.com |
| Print Name As | Determine the format the name should be printed. | John A. Doe |
| Restricted Department | Restricted department IDs. Use if OBJECTRESTRICTION is Restricted | |
| Restricted Location | Restricted location ID. Use if OBJECTRESTRICTION is Restricted | |
| Restriction Type | Type of restriction | |
| Return To Contact Name | Jane Smith | |
| Secondary Email Address | Secondary email address | jane.smith@example.com |
| Secondary Phone Number | Secondary phone number | +1-555-987-6543 |
| Secondary URL | Secondary URL | https://www.example.com |
| Send Automatic Payment Notification | ||
| State/Province | State or province | NY |
| Taxable | When true, the item is subject to taxation. When false, the item is tax-exempt. | |
| Tax ID | Tax identification number (EIN/SSN) | 12-3456789 |
| Term Discount Displayed On Check Stub | ||
| Vendor Account No | VEND-ACC-001 | |
| Vendor Billing Type | Standard | |
| 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-001 |
| Vendor Name | Acme Supplies Inc. | |
| Vendor Type ID | TYPE-001 | |
| ZIP/Postal Code | ZIP or postal code. | 10001 |
{
"data": {
"_status": "success",
"_functionName": "update",
"_controlId": "bf13a0a9-e0c7-4aa6-9003-207076761234",
"_listType": "objects",
"_count": 1,
"_data": [
{
"RECORDNO": "1234",
"VENDORID": "V-01234"
}
]
}
}
Changelog
2025-12-19
Enhanced Get Contact, Update Contact, Get Customer, Update Customer, Get Invoice, Update Invoice, Get Project, Update Project, Get Vendor, and Update Vendor actions with inline data source support for improved usability:
- The Record No input in Get Contact, Get Customer, Get Invoice, Get Project, and Get Vendor now displays available records directly in the dropdown
- The Contact Name input in Update Contact now displays available contacts directly in the dropdown
- The Customer ID input in Update Customer now displays available customers directly in the dropdown
- The Record Number input in Update Invoice now displays available invoices directly in the dropdown
- The Project ID input in Update Project now displays available projects directly in the dropdown
- The Vendor ID input in Update Vendor now displays available vendors directly in the dropdown
2025-06-27
Added actions for AR advances and AR adjustments to enhance accounts receivable management