Vendors

Vendors are individuals or companies that you pay for goods and services.

When you create a vendor, you provide a name and a unique identifier (unless the company is configured to auto-generate identifiers).

You can also designate a credit limit, set a payment priority, establish the payment method for the vendor, and so forth. For more information, see Create a vendor in the Sage Intacct Help Center.

List vendors

get/objects/accounts-payable/vendor

Returns a collection with a key, ID, and link for each vendor. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAccounts Payable
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Vendors
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "84",
      • "id": "Vend-00001",
      • "href": "/objects/accounts-payable/vendor/84"
      },
    • {
      • "key": "85",
      • "id": "Vend-00002",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "key": "60",
      • "id": "Vend-00003",
      • "href": "/objects/accounts-payable/vendor/60"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a vendor
post/objects/accounts-payable/vendor
Creates a new vendor. When you add a new vendor, you can provide key descriptive information about that vendor and establish how you want to pay them.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Add, Edit Vendors (Bank Details permissions required to access vendor bank account.)







SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Unique ID for the vendor. You must specify a unique vendor ID when creating a vendor unless document sequencing is configured, in which case the ID is auto-generated.


 
 Example:  "V-00014"
name
required
string
Name of the vendor as it will appear on lists and menus across your company.


 
 Example:  "NCS, Inc."
isOneTimeUse
boolean
 Default:  false
Set to true if this is a one-time or occasional use vendor that you do not want to include in standard vendor lists.


 
 Example:  true
status
string
 Default:  "active"
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
state
string
 Default:  "a"
Approval state when vendor approval is enabled.


    

  • s - submitted - The vendor record is new or was updated and is now awaiting approval. Accounts Payable and Purchasing transactions for the vendor can be saved as drafts but cannot be posted.
    • 

  • a - approved - The vendor has been approved. You can post Accounts Payable and Purchasing transactions for the vendor. 
    • 

  • r - declined - The vendor was declined during the approval process. Until the vendor is approved, you cannot post Accounts Payable or Purchasing transactions for the vendor.
    • 



 Enum: "a" "r" "s"  
 Example:  "s"
object
Optional vendor type, which is a category of vendors used for reporting purposes. Valid values include any vendor type ID defined by the company.


 
key
string or null
Unique key for the vendor type.


 
 Example:  "12"
id
string or null
Unique ID for the vendor type.


 
 Example:  "Wholesaler"
object
If the vendor is a subsidiary of another vendor, parent vendor of the subsidiary vendor.


 
key
string or null
Unique key for the vendor.


 
 Example:  "500"
id
string or null
Unique ID for the vendor.


 
 Example:  202
object
General Ledger (GL) account group that the vendor is part of.


 
key
string or null
Unique key for the vendor account group.


 
 Example:  "8"
id
string or null
Unique ID for the vendor account group.


 
 Example:  "OR151"
object
AP account label associated with the vendor.


 
key
string or null
Unique key for the account label.


 
 Example:  "10"
id
string or null
Name or other unique ID for the account label.


 
 Example:  "Equipment"
defaultLeadTime
integer or null
Lead time default (days) for inventory replenishment. This field applies only if replenishment is enabled on the Configure Inventory Control page in Sage Intacct.


 
 Example:  5
filePaymentService
string
 Default:  "none"
File payment service type.


 Enum: "ach" "bankFile" "none"  
 Example:  "bankFile"
object
Required when filePaymentService is set to bankFile.


 
paymentCountryCode
string or null
Bank file payment country code.


 Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "an" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" null "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "xk" "ye" "yt" "za" "zm" "zw"  
 Example:  "us"
paymentCurrency
string
Bank file payment currency.


 
 Example:  "EUR"
taxId
string or null
The tax identification number for the vendor.


 
 Example:  "192354308"
object
Tax payments annual report settings for Australian companies and entities.


 
isTparEnabled
boolean
 Default:  false
Set to true to include vendor payments in the Taxable payments annual report (TPAR).


 
 Example:  false
name
string
To report vendor payments using a name other than the print as name, specify that name in this field.


 
 Example:  "TPAR 1"
object
T5018 report settings for Canadian companies and entities.


 
isT5018Enabled
boolean
 Default:  false
Set to true to include vendor payments in the T5018 report.


 
 Example:  false
t5018Number
string
T5018 Business/SIN number.


 
 Example:  "123456789"
object
 
is1099Eligible
boolean
 Default:  false
Set to true if the vendor is 1099 eligible.


 
 Example:  true
nameOn1099
string or null
Vendor name as it should appear on 1099 forms.


 
 Example:  "NCS"
type
string or null
Type of 1099 form for the vendor.


 
 Example:  "MISC"
box
string or null
Box number for form 1099.


 
 Example:  "3"
object
Supporting document for the vendor.


 
key
string or null
Unique key for the attachment.


 
 Example:  "21"
id
string or null
Unique ID for the attachment.


 
 Example:  "Sales01"
isOnHold
boolean
 Default:  false
Set to true to prevent anyone from entering transactions against the vendor.


 
 Example:  true
doNotPay
boolean
 Default:  false
Set to true to prevent anyone from paying bills from the vendor.


 
 Example:  true
alwaysCreateBill
boolean
 Default:  false
If automated transaction matching for Purchasing workflows is enabled, set this field to true to have Sage Intacct create all future transactions for a vendor as AP bills.


 
 Example:  true
creditLimit
number
Amount of credit extended by the vendor.


 
 Example:  10000
retainagePercentage
number or null
The percentage of retainage to withhold for the vendor. (For Construction subscriptions only.)


 
 Example:  20
notes
string or null
Notes or comments about the vendor.


 
 Example:  "Make sure to include on form 1099."
object
Price list for the vendor.


 
key
string or null
Unique key for the price list.


 
 Example:  "13"
id
string or null
Unique ID for the price list.


 
 Example:  "Acme Price List"
object
Price schedule for the vendor.


 
key
string or null
Unique key for the price schedule.


 
 Example:  "5"
id
string or null
Unique ID for the price schedule.


 
 Example:  "PREF"
object
Default override offset GL account for the vendor.


 
key
string or null
Unique key for the account.


 
 Example:  "12"
id
string or null
Unique ID for the account.


 
 Example:  "1"
object
Default GL expense account for bills for the vendor.


 
key
string or null
Unique key for the account.


 
 Example:  "6"
id
string or null
Unique ID for the account.


 
 Example:  "1210"
discountPercent
number or null
Discount percentage for the vendor. Specify the percentage as a whole number, for example, specify 10 for 10%.


 
 Example:  10
object
 
object
Default contact for the vendor. Used as the default vendor in the vendor's contact list.


 
key
string
System-assigned unique key for the contact.


 
 Example:  "21"
id
string
Contact ID.


 
 Example:  "jsmith"
lastName
string or null
Last name.


 
 Example:  "Smith"
firstName
string or null
First name.


 
 Example:  "John"
middleName
string or null
Middle name.


 
 Example:  "Archibald"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr"
printAs
string
The contact's name as it will appear on documents.


 
 Example:  "John Smith"
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "14085551212"
phone2
string or null
Secondary phone number.


 
 Example:  "14085559876"
mobile
string or null
Mobile phone number.


 
 Example:  "14085554420"
pager
string or null
Pager number.


 
 Example:  "14085559987"
fax
string or null
Fax number.


 
 Example:  "14085555309"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://anothercompany.com"
companyName
string or null
Name of the company.


 
 Example:  "AlcoSoft Inc"
object
Mailing address.


 
hideContactList
boolean
 Default:  false
Set to true to exclude the contact from the company contact list.


 
 Example:  false
object
Tax information for the contact.


 
object
For businesses operating in France, the following fields are required to comply with local electronic invoicing regulations.


 
internationalTaxId
string
Business identification number for EU companies.


 
 Example:  "123"
object
Primary contact for the vendor.
The primary contact is the default contact for all transactions if no other contacts are defined.


 
key
string or null
Unique key for the contact.


 
 Example:  "7"
id
string or null
Name of the contact.


 
 Example:  "Jeff Pinkerton"
object
Default contact when paying by check or creating bills. This contact is required for calculating tax for purchasing.


 
key
string or null
Unique key for the contact.


 
 Example:  "2"
id
string or null
Name of the contact.


 
 Example:  "Klay Vanderbilt"
object
Default contact for purchasing transactions and for the return of purchases from purchasing transactions.


 
key
string or null
Unique key for the contact.


 
 Example:  "5"
id
string or null
Name of the contact.


 
 Example:  "Yusuf Pringle"
object
Default contact for all 1099 tax transactions and documents.


 
key
string or null
Unique key for the contact.


 
 Example:  "9"
id
string or null
Name of the contact.


 
 Example:  "Herb Culver"
Array of objects
Contact list for the vendor.


 
 Array 
categoryName
string
Category name for the vendor contact information, such as office, home, and so forth.


 
 Example:  "Main Office"
object
Contact to associate with the vendor.


 
object
Vendor this contact is associated with.


 
Array of objects or null
Templates used to automate standard messages sent to multiple vendors.


 
 Array 
object
Vendor associated with this email template.


 
txnDefinitionName
string
Type of transaction that will use this email template.


 
 Example:  "Vendor Invoice"
object
Email template associated with this vendor.


 
Array of objects
Payment providers for the vendor.


 
 Array 
id
string
Unique identifier for the vendor payment provider.


 
 Example:  "1"
object
 
object
 
object
 
status
string
Subscription status of the vendor payment provider.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Enable electronic payments to be made to vendors using a local bank file format.


 
 Array 
bankAccountNumber
string
Bank account number for the bank file payment.


 
 Example:  "IE26SCT666666"
bankAccountName
string
Bank account name for the bank file payment.


 
 Example:  "Jane Blogs Corp."
bsbNumber
string
Bank branch number for the vendor bank. Supported countries - Australia (AU).


 
 Example:  "047-359"
sortCode
string
Sort code for the bank file payment. Supported countries - United Kingdom (GB).


 
 Example:  "204718"
paymentReference
string
Payment reference number to connect the bank file and the bills to be paid. Supported countries - Australia (AU) and South Africa (ZA).


 
 Example:  "Supplier Inc"
branchCode
string
Branch code for the vendor bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "213456"
bankAccountType
string
Account type for the vendor bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "4"
bankAccountCode
string
Account code for the vendor bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "345624"
printPaymentProof
boolean
 Default:  true
Specify whether to print the proof of payment when the bank file payment batch is authorized. Supported countries - South Africa (ZA).


 
 Example:  true
businessIdCode
string
Creditor bank identifier code for the bank account. Supported countries - All European countries where Generic-SEPA file format is supported.


 
 Example:  "AIBKIE2D491"
creditorCode
string
Creditor code for the bank account. Supported countries - Canada (CA).


 
 Example:  "1234567891234567"
secondaryIdentifier
string
Bank number, as assigned by the account CAD financial institution.  Supported countries - Canada (CA).


 
 Example:  "00710423598"
accountClassification
string or null
 Default:  "ccd"
(This field applies only to companies in the United States.) Specifies the account classification for ACH transactions. 
Use PPD (Prearranged Payment and Deposit) for transactions with individual or consumer accounts. 
Use CCD (Corporate Credit or Debit) for transactions with business or corporate accounts.


 Enum: "ccd" null "ppd"  
 Example:  "ccd"
object
 
Array of objects
Account numbers associated with a vendor.


 
 Array 
id
string
Unique identifier for the vendor account number. This value is the same as the key value for this object.


 
 Example:  "1"
object
Location associated with the vendor account number.


 
vendorAccountNumber
string
Account number for the vendor.


 
 Example:  "VAN-5134986722"
object
Vendor this account number is associated with.


 
preferredPaymentMethod
string or null
 Default:  null
Preferred payment method when you select a bill to pay for the vendor.


 Enum: "ACH" "EFT" "cash" "chargeCard" null "printedCheck" "wellsFargoCheck" "wellsFargoDomesticACH" "wellsFargoUSDWire"  
 Example:  "EFT"
mergePaymentRequests
boolean
 Default:  true
If true, merge multiple selected bills into one payment request for the vendor. If false, have one payment request created for each bill.


 
 Example:  true
sendPaymentNotification
boolean
 Default:  false
If true, automatically send payment notifications to the email address for the payTo contact.


 
 Example:  true
billingType
string or null
 Default:  null
Billing type to use on vendor statements.


    

  • openItem - Shows all bills, adjustments, and payments as line items on a statements.
    • 

  • balanceForward - Consolidates previous months bills, adjustments, and payments to a single line item.
    • 



 Enum: "balanceForward" null "openItem"  
 Example:  "openItem"
paymentPriority
string or null
 Default:  null
Optional default payment priority to assign new bills from the vendor.


 Enum: "high" "low" "normal" null "urgent"  
 Example:  "low"
currency
string or null
Default currency.


 
 Example:  "USD"
displayTermDiscountOnCheckStub
boolean
 Default:  true
If true, include any associated term discount on check stubs.


 
 Example:  true
object
AP term or rules the vendor has established for extending credit to you.


 
key
string or null
Unique key for the AP term.


 
 Example:  "7"
id
string or null
Name of the AP term.


 
 Example:  "Net 30"
object
 
defaultDateOptions
string or null
 Default:  null
The Default bill payment date defines how the Recommended to pay on date is calculated for vendor bills. * none- Leaves the default unset, which allows you to choose the value from a different date field. * dueDate - Calculates the due date based on the selected term, then adjusts based on the number of days specified as an offset. * billDate - Uses the date entered for the bill, adjusted for the number of days specified as an offset. Does not require that a term be defined. * discountDate - Uses the discount details in the specified term to calculate the discount date. No offset is used.


 Enum: "billDate" "discountDate" "dueDate" "none" null  
 Example:  "none"
offsetTypePlusMinus
string or null
Specify whether to add (+) or subtract (-) days for the offset.


 Enum: "+" "-" null  
 Example:  "+"
dueNumberOfDays
integer or null
The number of days to use as an offset from the default payment due date.


 
 Example:  5
billNumberOfDays
integer or null
The number of days to use as an offset from the default payment bill date.


 
 Example:  10
vendorAccountNumber
string or null
The account number that the vendor has assigned to you.


 
 Example:  "203"
displayVendorAccountOnCheckStub
boolean
 Default:  false
Set to true to display the vendor-assigned account number, per entity, on check stubs.


 
 Example:  false
object
 
enablePayments
boolean
 Default:  false
Set to true to enable ACH payments for the vendor.


 
 Example:  false
routingNumber
string or null
ACH routing number for the vendor.


 
 Example:  "061080227"
accountNumber
string or null
ACH account number for the vendor.


 
 Example:  "7624832485"
accountType
string or null
 Default:  null
ACH account type for the vendor.


 Enum: "checkingAccount" null "savingsAccount"  
 Example:  "checkingAccount"
remittanceType
string or null
 Default:  null
ACH account classification for the vendor. Specify the classification code that the related bank uses for ACH payments: 


    

  • businessCTX - Business account that is a Corporate Trade Exchange (CTX) account.
    • 

  • personalPPD - An individual contractor's personal account.
    • 

  • businessCCD - Business account that is a Cash Concentration or Disbursement (CCD) corporate account.
    • 



 Enum: "businessCCD" "businessCTX" null "personalPPD"  
 Example:  "businessCTX"
vendorRestriction
string
 Default:  "unrestricted"
Vendor visibility type.


 Enum: "restricted" "rootOnly" "unrestricted"  
 Example:  "restricted"
Array of objects
Restricted locations for the vendor.


 
 Array 
object
Vendor that is restricted.


 
Array of objects
Restricted departments for the vendor.


 
 Array 
object
Vendor that is restricted.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Vend-00010",
  • "name": "Design Works",
  • "creditLimit": 40000,
  • "isOnHold": false,
  • "doNotPay": false,
  • "billingType": "openItem",
  • "paymentPriority": "normal",
  • "billPayment": {
    • "defaultDateOptions": "none"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "111",
    • "href": "/objects/accounts-payable/vendor/111"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a vendor
get/objects/accounts-payable/vendor/{key}
Returns detailed information for a specified vendor.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Vendors







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the vendor.


 
 Example:  111
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "111",
    • "id": "VEND-00010",
    • "name": "Design Works",
    • "status": "active",
    • "state": "a",
    • "taxId": "12-3456789",
    • "form1099": {
      • "nameOn1099": "Design Works Inc",
      • "type": "MISC",
      • "box": "3"
      },
    • "creditLimit": 40000,
    • "isOnHold": true,
    • "doNotPay": true,
    • "alwaysCreateBill": false,
    • "currency": "USD",
    • "contacts": {
      • "primary": {
        },
      • "payTo": {
        },
      • "returnTo": {
        },
      • "recipient1099": {
        }
      },
    • "mergePaymentRequests": true,
    • "sendPaymentNotification": true,
    • "restriction": {
      • "restrictionType": "unrestricted"
      },
    • "billingType": "openItem",
    • "paymentPriority": "normal",
    • "displayTermDiscountOnCheckStub": true,
    • "billPayment": {
      • "defaultDateOptions": "none"
      },
    • "displayVendorAccountOnCheckStub": true,
    • "ach": {
      • "enablePayments": false,
      • "routingNumber": null,
      • "accountNumber": null,
      • "accountType": null,
      • "remittanceType": null
      },
    • "audit": {
      • "modifiedDateTime": "2021-03-24T21:16:54Z",
      • "createdDateTime": "2021-03-24T21:16:54Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "id": "1",
      • "key": "1",
      • "name": "United States of America"
      },
    • "href": "/objects/accounts-payable/vendor/111"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a vendor
patch/objects/accounts-payable/vendor/{key}
Updates an existing vendor by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Edit Vendors







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the vendor.


 
 Example:  111
Request Body schema: application/json
name
string
Name of the vendor as it will appear on lists and menus across your company.


 
 Example:  "NCS, Inc."
isOneTimeUse
boolean
 Default:  false
Set to true if this is a one-time or occasional use vendor that you do not want to include in standard vendor lists.


 
 Example:  true
status
string
 Default:  "active"
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
state
string
 Default:  "a"
Approval state when vendor approval is enabled.


    

  • s - submitted - The vendor record is new or was updated and is now awaiting approval. Accounts Payable and Purchasing transactions for the vendor can be saved as drafts but cannot be posted.
    • 

  • a - approved - The vendor has been approved. You can post Accounts Payable and Purchasing transactions for the vendor. 
    • 

  • r - declined - The vendor was declined during the approval process. Until the vendor is approved, you cannot post Accounts Payable or Purchasing transactions for the vendor.
    • 



 Enum: "a" "r" "s"  
 Example:  "s"
object
Optional vendor type, which is a category of vendors used for reporting purposes. Valid values include any vendor type ID defined by the company.


 
key
string or null
Unique key for the vendor type.


 
 Example:  "12"
id
string or null
Unique ID for the vendor type.


 
 Example:  "Wholesaler"
object
If the vendor is a subsidiary of another vendor, parent vendor of the subsidiary vendor.


 
key
string or null
Unique key for the vendor.


 
 Example:  "500"
id
string or null
Unique ID for the vendor.


 
 Example:  202
object
General Ledger (GL) account group that the vendor is part of.


 
key
string or null
Unique key for the vendor account group.


 
 Example:  "8"
id
string or null
Unique ID for the vendor account group.


 
 Example:  "OR151"
object
AP account label associated with the vendor.


 
key
string or null
Unique key for the account label.


 
 Example:  "10"
id
string or null
Name or other unique ID for the account label.


 
 Example:  "Equipment"
defaultLeadTime
integer or null
Lead time default (days) for inventory replenishment. This field applies only if replenishment is enabled on the Configure Inventory Control page in Sage Intacct.


 
 Example:  5
filePaymentService
string
 Default:  "none"
File payment service type.


 Enum: "ach" "bankFile" "none"  
 Example:  "bankFile"
object
Required when filePaymentService is set to bankFile.


 
paymentCountryCode
string or null
Bank file payment country code.


 Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "an" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" null "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "xk" "ye" "yt" "za" "zm" "zw"  
 Example:  "us"
paymentCurrency
string
Bank file payment currency.


 
 Example:  "EUR"
taxId
string or null
The tax identification number for the vendor.


 
 Example:  "192354308"
object
Tax payments annual report settings for Australian companies and entities.


 
isTparEnabled
boolean
 Default:  false
Set to true to include vendor payments in the Taxable payments annual report (TPAR).


 
 Example:  false
name
string
To report vendor payments using a name other than the print as name, specify that name in this field.


 
 Example:  "TPAR 1"
object
T5018 report settings for Canadian companies and entities.


 
isT5018Enabled
boolean
 Default:  false
Set to true to include vendor payments in the T5018 report.


 
 Example:  false
t5018Number
string
T5018 Business/SIN number.


 
 Example:  "123456789"
object
 
is1099Eligible
boolean
 Default:  false
Set to true if the vendor is 1099 eligible.


 
 Example:  true
nameOn1099
string or null
Vendor name as it should appear on 1099 forms.


 
 Example:  "NCS"
type
string or null
Type of 1099 form for the vendor.


 
 Example:  "MISC"
box
string or null
Box number for form 1099.


 
 Example:  "3"
object
Supporting document for the vendor.


 
key
string or null
Unique key for the attachment.


 
 Example:  "21"
id
string or null
Unique ID for the attachment.


 
 Example:  "Sales01"
isOnHold
boolean
 Default:  false
Set to true to prevent anyone from entering transactions against the vendor.


 
 Example:  true
doNotPay
boolean
 Default:  false
Set to true to prevent anyone from paying bills from the vendor.


 
 Example:  true
alwaysCreateBill
boolean
 Default:  false
If automated transaction matching for Purchasing workflows is enabled, set this field to true to have Sage Intacct create all future transactions for a vendor as AP bills.


 
 Example:  true
creditLimit
number
Amount of credit extended by the vendor.


 
 Example:  10000
retainagePercentage
number or null
The percentage of retainage to withhold for the vendor. (For Construction subscriptions only.)


 
 Example:  20
notes
string or null
Notes or comments about the vendor.


 
 Example:  "Make sure to include on form 1099."
object
Price list for the vendor.


 
key
string or null
Unique key for the price list.


 
 Example:  "13"
id
string or null
Unique ID for the price list.


 
 Example:  "Acme Price List"
object
Price schedule for the vendor.


 
key
string or null
Unique key for the price schedule.


 
 Example:  "5"
id
string or null
Unique ID for the price schedule.


 
 Example:  "PREF"
object
Default override offset GL account for the vendor.


 
key
string or null
Unique key for the account.


 
 Example:  "12"
id
string or null
Unique ID for the account.


 
 Example:  "1"
object
Default GL expense account for bills for the vendor.


 
key
string or null
Unique key for the account.


 
 Example:  "6"
id
string or null
Unique ID for the account.


 
 Example:  "1210"
discountPercent
number or null
Discount percentage for the vendor. Specify the percentage as a whole number, for example, specify 10 for 10%.


 
 Example:  10
object
 
object
Default contact for the vendor. Used as the default vendor in the vendor's contact list.


 
key
string
System-assigned unique key for the contact.


 
 Example:  "21"
id
string
Contact ID.


 
 Example:  "jsmith"
lastName
string or null
Last name.


 
 Example:  "Smith"
firstName
string or null
First name.


 
 Example:  "John"
middleName
string or null
Middle name.


 
 Example:  "Archibald"
prefix
string or null
Prefix, such as Mr., Mrs., or Ms.


 
 Example:  "Mr"
printAs
string
The contact's name as it will appear on documents.


 
 Example:  "John Smith"
email1
string or null
Primary email address.


 
 Example:  "[email protected]"
email2
string or null
Secondary email address.


 
 Example:  "[email protected]"
phone1
string or null
Primary phone number.


 
 Example:  "14085551212"
phone2
string or null
Secondary phone number.


 
 Example:  "14085559876"
mobile
string or null
Mobile phone number.


 
 Example:  "14085554420"
pager
string or null
Pager number.


 
 Example:  "14085559987"
fax
string or null
Fax number.


 
 Example:  "14085555309"
URL1
string or null
Web page address for this contact.


 
 Example:  "https://mycompany.com"
URL2
string or null
Secondary web page address.


 
 Example:  "https://anothercompany.com"
companyName
string or null
Name of the company.


 
 Example:  "AlcoSoft Inc"
object
Mailing address.


 
hideContactList
boolean
 Default:  false
Set to true to exclude the contact from the company contact list.


 
 Example:  false
object
Tax information for the contact.


 
object
For businesses operating in France, the following fields are required to comply with local electronic invoicing regulations.


 
internationalTaxId
string
Business identification number for EU companies.


 
 Example:  "123"
object
Primary contact for the vendor.
The primary contact is the default contact for all transactions if no other contacts are defined.


 
key
string or null
Unique key for the contact.


 
 Example:  "7"
id
string or null
Name of the contact.


 
 Example:  "Jeff Pinkerton"
object
Default contact when paying by check or creating bills. This contact is required for calculating tax for purchasing.


 
key
string or null
Unique key for the contact.


 
 Example:  "2"
id
string or null
Name of the contact.


 
 Example:  "Klay Vanderbilt"
object
Default contact for purchasing transactions and for the return of purchases from purchasing transactions.


 
key
string or null
Unique key for the contact.


 
 Example:  "5"
id
string or null
Name of the contact.


 
 Example:  "Yusuf Pringle"
object
Default contact for all 1099 tax transactions and documents.


 
key
string or null
Unique key for the contact.


 
 Example:  "9"
id
string or null
Name of the contact.


 
 Example:  "Herb Culver"
Array of objects
Contact list for the vendor.


 
 Array 
categoryName
string
Category name for the vendor contact information, such as office, home, and so forth.


 
 Example:  "Main Office"
object
Contact to associate with the vendor.


 
object
Vendor this contact is associated with.


 
Array of objects or null
Templates used to automate standard messages sent to multiple vendors.


 
 Array 
object
Vendor associated with this email template.


 
txnDefinitionName
string
Type of transaction that will use this email template.


 
 Example:  "Vendor Invoice"
object
Email template associated with this vendor.


 
Array of objects
Payment providers for the vendor.


 
 Array 
id
string
Unique identifier for the vendor payment provider.


 
 Example:  "1"
object
 
object
 
object
 
status
string
Subscription status of the vendor payment provider.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Enable electronic payments to be made to vendors using a local bank file format.


 
 Array 
bankAccountNumber
string
Bank account number for the bank file payment.


 
 Example:  "IE26SCT666666"
bankAccountName
string
Bank account name for the bank file payment.


 
 Example:  "Jane Blogs Corp."
bsbNumber
string
Bank branch number for the vendor bank. Supported countries - Australia (AU).


 
 Example:  "047-359"
sortCode
string
Sort code for the bank file payment. Supported countries - United Kingdom (GB).


 
 Example:  "204718"
paymentReference
string
Payment reference number to connect the bank file and the bills to be paid. Supported countries - Australia (AU) and South Africa (ZA).


 
 Example:  "Supplier Inc"
branchCode
string
Branch code for the vendor bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "213456"
bankAccountType
string
Account type for the vendor bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "4"
bankAccountCode
string
Account code for the vendor bank account to which payments are made. Supported countries - South Africa (ZA).


 
 Example:  "345624"
printPaymentProof
boolean
 Default:  true
Specify whether to print the proof of payment when the bank file payment batch is authorized. Supported countries - South Africa (ZA).


 
 Example:  true
businessIdCode
string
Creditor bank identifier code for the bank account. Supported countries - All European countries where Generic-SEPA file format is supported.


 
 Example:  "AIBKIE2D491"
creditorCode
string
Creditor code for the bank account. Supported countries - Canada (CA).


 
 Example:  "1234567891234567"
secondaryIdentifier
string
Bank number, as assigned by the account CAD financial institution.  Supported countries - Canada (CA).


 
 Example:  "00710423598"
accountClassification
string or null
 Default:  "ccd"
(This field applies only to companies in the United States.) Specifies the account classification for ACH transactions. 
Use PPD (Prearranged Payment and Deposit) for transactions with individual or consumer accounts. 
Use CCD (Corporate Credit or Debit) for transactions with business or corporate accounts.


 Enum: "ccd" null "ppd"  
 Example:  "ccd"
object
 
Array of objects
Account numbers associated with a vendor.


 
 Array 
id
string
Unique identifier for the vendor account number. This value is the same as the key value for this object.


 
 Example:  "1"
object
Location associated with the vendor account number.


 
vendorAccountNumber
string
Account number for the vendor.


 
 Example:  "VAN-5134986722"
object
Vendor this account number is associated with.


 
preferredPaymentMethod
string or null
 Default:  null
Preferred payment method when you select a bill to pay for the vendor.


 Enum: "ACH" "EFT" "cash" "chargeCard" null "printedCheck" "wellsFargoCheck" "wellsFargoDomesticACH" "wellsFargoUSDWire"  
 Example:  "EFT"
mergePaymentRequests
boolean
 Default:  true
If true, merge multiple selected bills into one payment request for the vendor. If false, have one payment request created for each bill.


 
 Example:  true
sendPaymentNotification
boolean
 Default:  false
If true, automatically send payment notifications to the email address for the payTo contact.


 
 Example:  true
billingType
string or null
 Default:  null
Billing type to use on vendor statements.


    

  • openItem - Shows all bills, adjustments, and payments as line items on a statements.
    • 

  • balanceForward - Consolidates previous months bills, adjustments, and payments to a single line item.
    • 



 Enum: "balanceForward" null "openItem"  
 Example:  "openItem"
paymentPriority
string or null
 Default:  null
Optional default payment priority to assign new bills from the vendor.


 Enum: "high" "low" "normal" null "urgent"  
 Example:  "low"
currency
string or null
Default currency.


 
 Example:  "USD"
displayTermDiscountOnCheckStub
boolean
 Default:  true
If true, include any associated term discount on check stubs.


 
 Example:  true
object
AP term or rules the vendor has established for extending credit to you.


 
key
string or null
Unique key for the AP term.


 
 Example:  "7"
id
string or null
Name of the AP term.


 
 Example:  "Net 30"
object
 
defaultDateOptions
string or null
 Default:  null
The Default bill payment date defines how the Recommended to pay on date is calculated for vendor bills. * none- Leaves the default unset, which allows you to choose the value from a different date field. * dueDate - Calculates the due date based on the selected term, then adjusts based on the number of days specified as an offset. * billDate - Uses the date entered for the bill, adjusted for the number of days specified as an offset. Does not require that a term be defined. * discountDate - Uses the discount details in the specified term to calculate the discount date. No offset is used.


 Enum: "billDate" "discountDate" "dueDate" "none" null  
 Example:  "none"
offsetTypePlusMinus
string or null
Specify whether to add (+) or subtract (-) days for the offset.


 Enum: "+" "-" null  
 Example:  "+"
dueNumberOfDays
integer or null
The number of days to use as an offset from the default payment due date.


 
 Example:  5
billNumberOfDays
integer or null
The number of days to use as an offset from the default payment bill date.


 
 Example:  10
vendorAccountNumber
string or null
The account number that the vendor has assigned to you.


 
 Example:  "203"
displayVendorAccountOnCheckStub
boolean
 Default:  false
Set to true to display the vendor-assigned account number, per entity, on check stubs.


 
 Example:  false
object
 
enablePayments
boolean
 Default:  false
Set to true to enable ACH payments for the vendor.


 
 Example:  false
routingNumber
string or null
ACH routing number for the vendor.


 
 Example:  "061080227"
accountNumber
string or null
ACH account number for the vendor.


 
 Example:  "7624832485"
accountType
string or null
 Default:  null
ACH account type for the vendor.


 Enum: "checkingAccount" null "savingsAccount"  
 Example:  "checkingAccount"
remittanceType
string or null
 Default:  null
ACH account classification for the vendor. Specify the classification code that the related bank uses for ACH payments: 


    

  • businessCTX - Business account that is a Corporate Trade Exchange (CTX) account.
    • 

  • personalPPD - An individual contractor's personal account.
    • 

  • businessCCD - Business account that is a Cash Concentration or Disbursement (CCD) corporate account.
    • 



 Enum: "businessCCD" "businessCTX" null "personalPPD"  
 Example:  "businessCTX"
vendorRestriction
string
 Default:  "unrestricted"
Vendor visibility type.


 Enum: "restricted" "rootOnly" "unrestricted"  
 Example:  "restricted"
Array of objects
Restricted locations for the vendor.


 
 Array 
object
Vendor that is restricted.


 
Array of objects
Restricted departments for the vendor.


 
 Array 
object
Vendor that is restricted.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "billingType": "balanceForward"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "RituDate11-21-2015",
    • "href": "/objects/accounts-payable/vendor/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a vendor
delete/objects/accounts-payable/vendor/{key}
Deletes a vendor. You can only delete vendors that aren't tied to any transactions or payments.



Permissions and other requirements



SubscriptionAccounts Payable


User typeBusiness


PermissionsList, View, Delete Vendors







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the vendor.


 
 Example:  111
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Approve a vendor
post/workflows/accounts-payable/vendor/approve
When vendor approval is enabled, new and recently edited vendors are automatically submitted to an approval queue. Vendors submitted to the approval queue have a state of submitted. Designated approvers review those vendors and either approve or decline them. When a vendor is approved, the state for that vendor changes from submitted to approved. 


For more information, see About vendor approvals in the Sage Intacct Help Center.



Permissions and other requirements



SubscriptionAccounts Payable


ConfigurationVendor approval enabled


User typeBusiness, Employee


PermissionsApprove vendors - List







SecurityOAuth2 
Request 
Request Body schema: application/json
key
string
System-assigned key for the vendor.


 
 Example:  "518"
notes
string
Notes or comments about this vendor.


 
 Example:  "Approved, ready for use"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "518",
  • "notes": "Approved, ready for use"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "518",
    • "id": "V-00014",
    • "href": "/objects/accounts-payable/vendor/518",
    • "state": "approved"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Decline a vendor
post/workflows/accounts-payable/vendor/decline
When vendor approval is enabled, new and recently edited vendors are automatically submitted to an approval queue. Vendors submitted to the approval queue have a state of submitted. Designated approvers review those vendors and either approve or decline them. When a vendor is declined, the state for that vendor changes from submitted to declined.  


For more information, see About vendor approvals in the Sage Intacct Help Center.



Permissions and other requirements



SubscriptionAccounts Payable


ConfigurationVendor approval enabled


User typeBusiness, Employee


PermissionsApprove vendors - List







SecurityOAuth2 
Request 
Request Body schema: application/json
key
string
System-assigned key for the vendor.


 
 Example:  "518"
notes
string
Notes or comments about this vendor.


 
 Example:  "Declined, missing information"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "518",
  • "notes": "Declined, missing information"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "518",
    • "id": "V-00014",
    • "href": "/objects/accounts-payable/vendor/518",
    • "state": "declined"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Query vendors
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-payable/vendor"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "parent.id",
    • "accountGroup.id",
    • "isOnHold",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "38",
      • "id": "1099 INTCA",
      • "parent.id": "A100",
      • "accountGroup.id": "Long Term Debt & Other",
      • "isOnHold": false,
      • "href": "/objects/accounts-payable/vendor/38"
      },
    • {
      • "key": "43",
      • "id": "1099 INT",
      • "parent.id": "210",
      • "accountGroup.id": "Equity",
      • "isOnHold": false,
      • "href": "/objects/accounts-payable/vendor/43"
      },
    • {
      • "key": "47",
      • "id": "1099INTTX",
      • "parent.id": "213",
      • "accountGroup.id": "Equity",
      • "isOnHold": true,
      • "href": "/objects/accounts-payable/vendor/47"
      },
    • {
      • "key": "48",
      • "id": "1099 INTGA",
      • "parent.id": "210",
      • "accountGroup.id": "Capital",
      • "isOnHold": false,
      • "href": "/objects/accounts-payable/vendor/48"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}