Sage Intacct Component

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

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.

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

API Reference: Sage Intacct API Reference

Connections

Sage Intacct Connection

Web Service Authentication

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

Input	Notes	Example
Company ID	Company ID for Web Services Authentication
Entity ID	Entity ID for Web Services Authentication
Sender ID	Sender ID for Web Services Authentication
Sender Password	Sender Password for Web Services Authentication
User ID	User ID for Web Services Authentication
User Password	User Password for Web Services Authentication

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
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.	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

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
Base Currency	Base currency code	USD
Bill Number	A Bill Number identifier	1234
Bill Transaction Date	Transaction date	12/06/2023
Bill GL Posting Date	General ledger posting date	12/06/2023
Connection
Currency	Transaction currency code	USD
Description	Description of the bill	My bill
Reference Number	A reference number for the bill	Ref 5678
Due Date	Due date	12/06/2023
On Hold	Place this bill on hold
Payment Priority
Recommended to pay on	Payment date	12/06/2023
Term Name	Payment term, this should be a previously created term	Net 10
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	Flag indicating if the status is active
Address Line 1	First line's address	123 Main St.
Address Line 2	Second line's address	123 Robert S Kerr Ave
Cellular Phone Number	Cellular phone number
City	City name.	Oklahoma City
Company Name	Name of the company
Connection
Contact Name	Contact name to create
Contact Tax Group Name	Name of the tax group
Country	Country name.	United States
Fax Number	Fax number
First Name	First name
Last Name	Last name
Middle Name	Middle name
Pager Number	Pager number
Prefix	Prefix for the name
Primary Email Address	Primary email address
Primary Phone Number	Primary phone number
Primary URL	Primary URL	https://www.example.com
Print Name As	Determine the format the name should be printed.
Secondary Email Address	Secondary email address
Secondary Phone Number	Secondary phone number
Secondary URL	Secondary URL	https://www.example.com
State/Province	State or province	Oklahoma
Taxable	Flag indicating if taxable
Tax ID	Tax identification number
ZIP/Postal Code	ZIP or postal code.	73102

{
  "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	Flag indicating if the status is active
Address Line 1	First line's address	123 Main St.
Address Line 2	Second line's address	123 Robert S Kerr Ave
Attachments ID	Id of an attachment group of one or more supporting files
Bill To Contact Name	Bill to contact. If blank system will use DISPLAYCONTACT.
Cellular Phone Number	Cellular phone number
City	City name.	Oklahoma City
Comments	Additional comments
Company Name	Name of the company
Connection
Contact Tax Group Name	Name of the tax group
Country	Country name.	United States
Credit Limit	Credit limit
Customer ID	Unique ID. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Customer Name	Name
Customer Type ID	Identifier for the type of customer
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
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	Flag indicating if excluded from contact lists
Fax Number	Fax number
First Name	First name
GL Group Name	Name of the 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
Middle Name	Middle name
Offset AR GL Account No	Offset AR GL account number
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	Flag indicating if on hold
Pager Number	Pager number
Parent Customer ID	Identifier of the parent customer
Payment Term	A previously created payment term	Net 30
Prefix	Prefix for the name
Primary Contact Name	Primary contact. If blank system will use DISPLAYCONTACT.
Primary Email Address	Primary email address
Primary Phone Number	Primary phone number
Primary URL	Primary URL	https://www.example.com
Print Name As	Determine the format the name should be printed.
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 number
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
Secondary Email Address	Secondary email address
Secondary Phone Number	Secondary phone number
Secondary URL	Secondary URL	https://www.example.com
Shipping Method	Shipping method
Ship To Contact Name	Ship to contact. If blank system will use DISPLAYCONTACT.
State/Province	State or province	Oklahoma
Taxable	Flag indicating if taxable
Tax ID	Tax identification number
Territory ID	Identifier for the territory
ZIP/Postal Code	ZIP or postal code.	73102

{
  "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
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.
Connection
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.	2
Ship To Contact Name	The name of the contact to ship to. This should be an existing contact in Intacct.
Term Name	Payment term, this should be a previously created term	Net 10

{
  "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
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
ACH Bank Account No
ACH Bank Account Type
ACH Bank Routing No
ACH Enabled
Active Status	Flag indicating if the status is active
Address Line 1	First line's address	123 Main St.
Address Line 2	Second line's address	123 Robert S Kerr Ave
Attachments ID	Id of an attachment group of one or more supporting files
Cellular Phone Number	Cellular phone number
City	City name.	Oklahoma City
Comments	Additional comments
Company Name	Name of the company
Connection
Contact Tax Group Name	Name of the tax group
Country	Country name.	United States
Credit Limit	Credit limit
Custom Fields	Custom field names and values as defined for this object
Default Currency	Default currency code	USD
Default Expense GL Account No
Do Not Pay
Excluded From Contact List	Flag indicating if excluded from contact lists
Fax Number	Fax number
First Name	First name
Form 1099 Box
Form 1099 Name
Form 1099 Type
GL Group Name	Name of the 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
Location Assigned Account No Displayed On Check Stub
Merge Payment Requests
Middle Name	Middle name
Offset GL Account No
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	Flag indicating if on hold
Pager Number	Pager number
Parent Vendor ID
Payment Priority
Payment Term	A previously created payment term	Net 30
Pay To Contact Name
Preferred Payment Method
Prefix	Prefix for the name
Primary Contact Name	Primary contact. If blank system will use DISPLAYCONTACT.
Primary Email Address	Primary email address
Primary Phone Number	Primary phone number
Primary URL	Primary URL	https://www.example.com
Print Name As	Determine the format the name should be printed.
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
Secondary Email Address	Secondary email address
Secondary Phone Number	Secondary phone number
Secondary URL	Secondary URL	https://www.example.com
Send Automatic Payment Notification
State/Province	State or province	Oklahoma
Taxable	Flag indicating if taxable
Tax ID	Tax identification number
Term Discount Displayed On Check Stub
Vendor Account No
Vendor Billing Type
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
Vendor Type ID
ZIP/Postal Code	ZIP or postal code.	73102

{
  "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
Keys	A key or comma-separated list (123,456) of keys (RECORDNO's) to delete	123
Object	Type of object to delete

Get AP Payment

Retrieve a single AP Payment. | key: getApPayment

Input	Notes	Example
Connection
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

{
  "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
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

Get AR Adjustment Line

Retrieve a single AR Adjustment Line. | key: getARAdjustmentLine

Input	Notes	Example
Connection
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

Get AR Advance

Retrieve a single AR Advance. | key: getARAdvance

Input	Notes	Example
Connection
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

Get AR Payment

Retrieve a single AR Payment. | key: getArPayment

Input	Notes	Example
Connection
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

{
  "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
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

{
  "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
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

{
  "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
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

{
  "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
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

Get Project

Retrieve a project by record number. | key: getProject

Input	Notes	Example
Connection
Field	Field to retrieve, use * for all fields	*
Record No	Record number of the project to retrieve.	2

{
  "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
Field	Field to retrieve, use * for all fields	*
Record No	Record number	2

{
  "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
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 to filter the records	VENDOR.CREDITLIMIT

{
  "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
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

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
Currency	AR Adjustment CURRENCY to update.	USD
Customer ID	AR Adjustment CUSTOMERID to update.
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.	My bill
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

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
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.	2
Undeposited Account No	AR Advance UNDEPOSITEDACCOUNTNO to update.	1020

Update Contact

Update an existing contact. | key: updateContact

Input	Notes	Example
Active Status	Flag indicating if the status is active
Address Line 1	First line's address	123 Main St.
Address Line 2	Second line's address	123 Robert S Kerr Ave
Cellular Phone Number	Cellular phone number
City	City name.	Oklahoma City
Company Name	Name of the company
Connection
Contact Name	Full name of the contact
Contact Tax Group Name	Name of the tax group
Country	Country name.	United States
Fax Number	Fax number
First Name	First name
Last Name	Last name
Middle Name	Middle name
Pager Number	Pager number
Prefix	Prefix for the name
Primary Email Address	Primary email address
Primary Phone Number	Primary phone number
Primary URL	Primary URL	https://www.example.com
Print Name As	Determine the format the name should be printed.
Secondary Email Address	Secondary email address
Secondary Phone Number	Secondary phone number
Secondary URL	Secondary URL	https://www.example.com
State/Province	State or province	Oklahoma
Taxable	Flag indicating if taxable
Tax ID	Tax identification number
ZIP/Postal Code	ZIP or postal code.	73102

{
  "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	Flag indicating if the status is active
Address Line 1	First line's address	123 Main St.
Address Line 2	Second line's address	123 Robert S Kerr Ave
Attachments ID	Id of an attachment group of one or more supporting files
Bill To Contact Name	Bill to contact. If blank system will use DISPLAYCONTACT.
Cellular Phone Number	Cellular phone number
City	City name.	Oklahoma City
Comments	Additional comments
Company Name	Name of the company
Connection
Contact Tax Group Name	Name of the tax group
Country	Country name.	United States
Credit Limit	Credit limit
Customer ID	Unique ID. Required if company does not use document sequencing, or you can provide a value to use instead of the document sequence value.
Customer Name	Name
Customer Type ID	Identifier for the type of customer
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
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	Flag indicating if excluded from contact lists
Fax Number	Fax number
First Name	First name
GL Group Name	Name of the 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
Middle Name	Middle name
Offset AR GL Account No	Offset AR GL account number
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	Flag indicating if on hold
Pager Number	Pager number
Parent Customer ID	Identifier of the parent customer
Payment Term	A previously created payment term	Net 30
Prefix	Prefix for the name
Primary Contact Name	Primary contact. If blank system will use DISPLAYCONTACT.
Primary Email Address	Primary email address
Primary Phone Number	Primary phone number
Primary URL	Primary URL	https://www.example.com
Print Name As	Determine the format the name should be printed.
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 number
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
Secondary Email Address	Secondary email address
Secondary Phone Number	Secondary phone number
Secondary URL	Secondary URL	https://www.example.com
Shipping Method	Shipping method
Ship To Contact Name	Ship to contact. If blank system will use DISPLAYCONTACT.
State/Province	State or province	Oklahoma
Taxable	Flag indicating if taxable
Tax ID	Tax identification number
Territory ID	Identifier for the territory
ZIP/Postal Code	ZIP or postal code.	73102

{
  "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
Base Currency	Base currency code	USD
Connection
Contact Name	Full name of the contact
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.
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 10

Update Project

Updates an existing project. | key: updateProject

Input	Notes	Example
Additional Fields	Additional fields that are not covered by the standard inputs.
Connection
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
ACH Bank Account No
ACH Bank Account Type
ACH Bank Routing No
ACH Enabled
Active Status	Flag indicating if the status is active
Address Line 1	First line's address	123 Main St.
Address Line 2	Second line's address	123 Robert S Kerr Ave
Attachments ID	Id of an attachment group of one or more supporting files
Cellular Phone Number	Cellular phone number
City	City name.	Oklahoma City
Comments	Additional comments
Company Name	Name of the company
Connection
Contact Tax Group Name	Name of the tax group
Country	Country name.	United States
Credit Limit	Credit limit
Custom Fields	Custom field names and values as defined for this object
Default Currency	Default currency code	USD
Default Expense GL Account No
Do Not Pay
Excluded From Contact List	Flag indicating if excluded from contact lists
Fax Number	Fax number
First Name	First name
Form 1099 Box
Form 1099 Name
Form 1099 Type
GL Group Name	Name of the 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
Location Assigned Account No Displayed On Check Stub
Merge Payment Requests
Middle Name	Middle name
Offset GL Account No
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	Flag indicating if on hold
Pager Number	Pager number
Parent Vendor ID
Payment Priority
Payment Term	A previously created payment term	Net 30
Pay To Contact Name
Preferred Payment Method
Prefix	Prefix for the name
Primary Contact Name	Primary contact. If blank system will use DISPLAYCONTACT.
Primary Email Address	Primary email address
Primary Phone Number	Primary phone number
Primary URL	Primary URL	https://www.example.com
Print Name As	Determine the format the name should be printed.
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
Secondary Email Address	Secondary email address
Secondary Phone Number	Secondary phone number
Secondary URL	Secondary URL	https://www.example.com
Send Automatic Payment Notification
State/Province	State or province	Oklahoma
Taxable	Flag indicating if taxable
Tax ID	Tax identification number
Term Discount Displayed On Check Stub
Vendor Account No
Vendor Billing Type
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
Vendor Type ID
ZIP/Postal Code	ZIP or postal code.	73102

{
  "data": {
    "_status": "success",
    "_functionName": "update",
    "_controlId": "bf13a0a9-e0c7-4aa6-9003-207076761234",
    "_listType": "objects",
    "_count": 1,
    "_data": [
      {
        "RECORDNO": "1234",
        "VENDORID": "V-01234"
      }
    ]
  }
}

Changelog

2025-06-27

Added actions for AR advances and AR adjustments to enhance accounts receivable management.

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

Description​

Connections​

Sage Intacct Connection​

Actions​

Create AR Advance​

Create Bill​

Create Contact​

Create Customer​

Create Invoice​

Create Project​

Create Vendor​

Delete Object​

Get AP Payment​

Get AR Adjustment​

Get AR Adjustment Line​

Get AR Advance​

Get AR Payment​

Get Bill​

Get Contact​

Get Customer​

Get Invoice​

Get Project​

Get Vendor​

Query and List Records​

Raw Request​

Update AR Adjustment​

Update AR Advance​

Update Contact​

Update Customer​

Update Invoice​

Update Project​

Update Vendor​

Changelog​

2025-06-27​

Description

Connections

Sage Intacct Connection

Actions

Create AR Advance

Create Bill

Create Contact

Create Customer

Create Invoice

Create Project

Create Vendor

Delete Object

Get AP Payment

Get AR Adjustment

Get AR Adjustment Line

Get AR Advance

Get AR Payment

Get Bill

Get Contact

Get Customer

Get Invoice

Get Project

Get Vendor

Query and List Records

Raw Request

Update AR Adjustment

Update AR Advance

Update Contact

Update Customer

Update Invoice

Update Project

Update Vendor

Changelog

2025-06-27