SCHEMAS
Introduction
Account
Bill
Class
Customer
Department
GeneralLedgerReport
Invoice
Item
JournalEntry
Location
Subsidiary
TrialBalanceReport
Vendor
Introduction
A single schema to push and pull Accounting data across connectors.
Supported Connectors
Microsoft Dynamics Business Central
NetSuite
QuickBooks
Sage Intacct
Xero
Account(Accounts)
Parameters
id
String
id
Unique identifier for the account in the system. Serves as the primary key for internal referencing.
externalId
String
externalid
External identifier for the account, used for mapping with external systems.
name
String
fullname | acctName | accountsearchdisplayname
Official name of the account as it appears in the system, typically the account's display name.
fullyQualifiedName
String
displaynamewithhierarchy
Account’s name combined with the names of its parent accounts, reflecting its hierarchy.
description
String
description
Detailed description of the account, explaining its purpose and usage in the chart of accounts.
accountNumber
String
acctnumber
Unique account number assigned for financial tracking and reporting.
parentId
String
parent
Unique identifier of the parent account, if applicable. Links the account to its parent in a hierarchical chart of accounts.
parentName
String
pick(accounts, "id", rec.parent, "name")
Name of the parent account, if applicable.
type
String
acctType
Type of account, such as Asset, Liability, Equity, Income, or Expense. Used for financial reporting.
category
String
N/A
Classification of the account, such as Bank, Credit Card, or Accounts Receivable, to help organize accounts.
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
Unique identifier for the currency associated with the account.
currencyName
String
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
isActive
Boolean
NOT isinactive
True if this account is active.
subsidiary
String [ ]
subsidiary.split(",")
Array of unique identifiers representing the subsidiaries associated with the account.
subsidiaryRef
Object [ ]
pick(subsidiaries, "id", rec.subsidiary.split(","), ["id", "name"])
Array of objects containing details of the subsidiaries in the format {id, name}.
classId
String
class
Unique identifier for the class associated with the account
className
String
pick(classes, "id", rec.class, "name")
Name of the class.
departmentId
String
department
Unique identifier for the department associated with the account.
departmentName
String
pick(departments, "id", rec.department, "name")
Name of the department associated with the account.
locationId
String
location
Unique identifier for the physical or geographical location where a transaction occurred.
locationName
String
pick(locations, "id", rec.location, "name")
Name of the location associated with the account.
isBankAccount
Boolean
rec.accttype == "Bank"
Boolean field (true or false) indicating whether the account is a bank account. Bank accounts have special handling for reconciliation and transactions.
updatedAt
Datetime
lastmodifieddate
Timestamp indicating when the account was last updated, useful for tracking changes.
createdAt
Datetime
N/A
Timestamp indicating when the account was created in the system, useful for auditing.
hgTenantId
String
{{tenantId}}
Unique identifier of the tenant or company that owns the account.
NetSuite
Example
{
"id": "111",
"externalId": "SF111",
"name": "Accounts Payable",
"fullyQualifiedName": "Accounts Payable",
"type": "AcctPay",
"currency":"USD",
"currencyId":"1",
"currencyName":"US Dollar",
"classId":"2",
"className":"Project 2",
"departmentId":"6",
"departmentName":"Accounting and finance",
"locationId":"3",
"locationName":"USA",
"isActive": true,
"subsidiary": [
"1",
"2",
"3"
],
"subsidiaryRef": [
{
"id": "2",
"name": "California"
},
{
"id": "1",
"name": "Parent Company"
},
{
"id": "3",
"name": "Virginia"
}
],
"isBankAccount": false,
"updatedAt": "2025-02-23T00:00:00.000000Z",
"hgTenantId": "default"
}Bill(Bills)
Parameters
id
String
id
Unique identifier for the bill. Serves as the primary key for internal referencing.
transactionNumber
String
transactionNumber
Internal reference number for tracking the bill.
externalId
String
externalId | tranid
ID from an external system, if applicable.
vendorId
String
entity
Unique identifier of the vendor associated with the bill.
vendorName
String
pick(vendors, "id", rec.entity, "name")
Name of the vendor associated with the bill.
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
Unique identifier for the currency.
currencyName
String
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
status
String
BUILTIN.DF(t.Status)
Current status of the bill (e.g., Pending, Paid).
dueDate
Datetime
duedate
Date by which the bill must be paid.
balance
Number
foreignamountunpaid
Outstanding balance remaining on the bill.
locationId
String
N/A
Unique identifier for the location associated with the bill.
locationName
String
N/A
Name of the location associated with the bill.
totalAmount
Number
foreigntotal
Total amount of the bill.
createdAt
Datetime
createddate
Timestamp indicating when the bill was created.
updatedAt
Datetime
lastmodifieddate
Timestamp indicating when the bill was last updated.
issueDate
Datetime
trandate
Date when the bill was issued.
customFields
CustomField [ ]
list( CustomField, pickRegex(rec, 'cust[.]*') )
Additional metadata or custom attributes related to the bill.
View CustomField Properties
name
{ "custentity_[field_id]": "Direct" } -> "custentity_[field_id]"
id of the custom field attribute
value
{ "custentity_[field_id]": "Direct" } -> "Direct"
Value of custom field
hgTenantId
String
{tenantId}
Unique identifier for the HotGlue tenant associated with the bill.
exchangeRate
Number
exchangerate
Exchange rate applied if the bill is in a foreign currency.
lineItems
BillLineItem [ ]
list(BillLineItem, pick(transactionLine, "transaction", rec.id))
List of individual items included in the bill.
View BillLineItem Properties
id
id
Unique identifier for the bill item, auto-generated by the system.
billId
transaction
Unique identifier of the bill or purchase order associated with this item.
itemId
item
Unique identifier of the product or service listed in the bill.
itemName
pick(items, "id", rec.item, "name")
Name of the product or service associated with the itemId.
accountId
N/A
Unique identifier of the ledger account linked to this transaction (e.g., Sales, Expense).
accountName
N/A
Name of the ledger account associated with this item.
description
memo
Additional details or notes about the item or service in this bill line.
taxCode
N/A
Tax code applicable to this bill item for tax calculation.
discount
N/A
Discount applied to this bill item, if any.
quantity
quantity
Number of units of the product or service in this bill line.
unitPrice
rate
Price per unit of the product or service before applying discounts or taxes.
totalPrice
netamount
Total cost of this bill item, calculated as (unitPrice × quantity) after any discounts or taxes.
serviceDate
N/A
Date when the service was provided or the item was delivered, if applicable.
customFields
pickRegex(rec, 'cust[.]*')
Additional metadata or custom attributes for this bill item.
classId
class
Unique identifier for the classification of this transaction for reporting purposes.
className
pick(classes, "id", rec.class, "name")
Name of the classification
locationId
location
Unique identifier of the location associated with this bill item.
locationName
pick(locations, "id", rec.location, "name")
Name of the location linked to this bill item.
departmentId
department
Unique identifier of the department responsible for this bill item.
departmentName
pick(departments, "id", rec.department, "name")
Name of the department
There is no external id concept on bill line item
expenses
BillExpense [ ]
list(BillExpense, pick(transactionLine, "transaction", rec.id))
Breakdown of expenses related to the bill.
View BillExpense Properties
id
id
The unique identifier for the transaction line, typically auto-generated by the system.
billId
transaction
The reference ID of the related bill or purchase order associated with the transaction line.
accountId
expenseAccount
The account associated with the transaction line, typically reflecting the ledger account involved in the financial transaction (e.g., Sales, Expense).
accountName
N/A
A reference to the account, including key details such as account ID, name, and other account-related attributes.
description
memo
A text field for providing additional details about the transaction line, such as notes or specifications about the item/service.
taxCode
N/A
The tax code applied to the transaction line, used for calculating the tax amount based on the tax rules defined for the item/service.
discount
N/A
The discount applied to the transaction line.
quantity
N/A
The number of units of the item or service being sold or purchased in the transaction line.
unitPrice
N/A
The price per individual unit of the item or service in the transaction line, before applying any discounts or taxes.
totalPrice
netamount
The total price for the transaction line, usually calculated as unitPrice × quantity, after discounts and taxes are applied.
serviceDate
N/A
The date when the service was provided or the item was delivered, if applicable.
customFields
pickRegex(rec, 'cust[.]*')
Additional custom fields for storing extra customer details.
classId
class
Categorizes transactions or records for detailed reporting
className
pick(classes, "id", rec.class, "name")
Includes key details about class. {id, name}
locationId
location
The location associated with the bill.
locationName
pick(locations, "id", rec.location, "name")
Name of the location associated with the bill.
departmentId
department
The department within the company
departmentName
pick(departments, "id", rec.department, "name")
Includes key details about department. {id, name}
subsidiaryId
subsidiary
id of the subsidiary
subsidiaryName
pick(subsidiary, "id", rec.subsidiary, "name")
Include key details about the primary subsidiary {id, name}
notes
String [ ]
N/A
Additional notes or comments related to the bill.
attachments
String [ ]
N/A
Supporting documents related to the bill.
list(BillPayments, pick(billPayments, "transaction", rec.id))
Payments associated with settling the bill.
subsidiaryId
subsidiary
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
BillPayments [ ]
pick(subsidiary, "id", rec.subsidiary, "name")
Name of the subsidiary associated with the bill.
View BillPayments Properties
billId
transaction
The reference ID of the bill associated with the payment.
id
id
The unique identifier for the payment transaction related to the bill.
paymentTransactionNumber
transactionNumber
Internal reference number for tracking the bill payment.
externalId
externalId | tranid
ID from an external system, if applicable.
paymentDate
tranDate
The date when the payment was made or recorded for the bill.
paymentStatus
status
The status of the payment, indicating whether the payment has been completed.
amount
amount
The total amount of the payment made towards the bill, typically reflecting the full or partial payment.
currency
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
currency
Unique identifier for the currency.
currencyName
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
exchangeRate
exchangeRate
The exchange rate applied if the payment is made in a different currency than the bill's currency, used to calculate the conversion.
accountId
account
The account associated with the transaction line, typically reflecting the ledger account involved in the financial transaction (e.g., Sales, Expense).
accountName
account
A reference to the account, including key details such as account ID, name, and other account-related attributes.
NetSuite
Example
{
"id": "9430",
"transactionNumber": "VENDBILL469",
"externalId":"B-900",
"vendorId": "8734",
"vendorName": "Rolex",
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"status": "Bill : Open",
"dueDate": "2025-03-01T00:00:00.000000Z",
"balance": 1010.0,
"totalAmount": -1010.0,
"issueDate": "2025-02-05T00:00:00.000000Z",
"exchangeRate": 1.0,
"lineItems": [
{
"id": "2",
"billId": "9430",
"itemId": "1815",
"itemName": "1151617",
"accountId": null,
"accountName": null,
"description": "Paper and Pens",
"taxCode": null,
"discount": null,
"quantity": 10.0,
"unitPrice": 50.0,
"totalPrice": 500.0,
"serviceDate": null,
"customFields": [
{
"name": "custcol1",
"value": 23
}
],
"classId": "1",
"className": "Project 1",
"locationId": "1",
"locationName": "NOAM",
"departmentId": "5",
"departmentName": "Sales"
}
],
"expenses": [
{
"id": "1",
"billId": "9430",
"accountId": "58",
"accountName": null,
"description": "Monthly office rent",
"taxCode": null,
"discount": null,
"quantity": null,
"unitPrice": null,
"totalPrice": 500.0,
"serviceDate": null,
"customFields": [
{
"name": "custcol1",
"value": 23
}
],
"classId": "1",
"className": "Project 1",
"locationId": "1",
"locationName": "NOAM",
"departmentId": "5",
"departmentName": "Sales",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company"
}
],
"customFields":[
{
"name": "custbody2",
"value": 23
},
{
"name": "custbody3",
"value": true
},
{
"name": "custbody_ste_discounted_price",
"value": "Hello"
}
],
"updatedAt": "2025-03-18T00:00:00.000000Z",
"createdAt": "2025-03-17T00:00:00.000000Z",
"hgTenantId": true
}Class(Classes)
Parameters
id
String
id
Unique identifier for the class
externalId
String
externalId
Unique identifier for the location in an external system.
classNumber
String
N/A
A unique numerical or alphanumeric identifier assigned to the class.
name
String
name
The primary, descriptive name of the class. This is a human-readable label for easy identification.
fullname
String
fullname
The full, hierarchical name of the class, reflecting its position within the class hierarchy.
description
String
N/A
Description of this class.
parentId
String
parent
The unique identifier of the parent class.
parentName
String
pick(classes, "id", rec.parent, ["id", "name"])
Name of the parent calss.
subsidiary
String [ ]
subsidiary.split(",")
An array of id(s) representing the subsidiaries associated with the class.
subsidiaryRef
Object [ ]
pick(subsidiaries, "id", rec.subsidiary.split(","), ["id", "name"])
An array of objects, includes key details about subsidiary. {id, name}
isActive
Boolean
NOT isinactive
Indicates current status of the class, Active. Deleted, Unknown
updatedAt
Datetime
lastModifiedDate
Timestamp of the last update made to the class.
createdAt
Datetime
N/A
Timestamp of when the class was created.
hgTenantId
String
{tenantId}
Identifier for the tenant to which the class belongs.
NetSuite
Example
{
"id":"1",
"externalId":"pr-001",
"name":"Project 1",
"fullname":"Project 2 : Project 1",
"parentId":"2",
"parentName":"Project 2",
"subsidiary":[
"1",
"2",
"3",
"4"
],
"subsidiaryRef":[
{
"id":"2",
"name":"California"
},
{
"id":"4",
"name":"New York"
},
{
"id":"1",
"name":"Parent Company"
},
{
"id":"3",
"name":"Virginia"
}
],
"isActive":false,
"updatedAt":"2025-02-25T00:00:00.000000Z",
"hgTenantId":true
}Customer(Customers)
Parameters
id
String
id
Unique identifier for the customer within the system. Serves as the primary key.
externalId
String
externalId
External reference ID used to link the customer with external systems.
isPerson
Boolean
isPerson
True if this customer is an individual, and not a company.
companyName
String
companyName
Official name of the customer’s company.
fullName
String
fullname
Full name of the customer, including first, middle, and last names.
prefix
String
salutation
Title preceding the customer’s name (e.g., Mr., Ms., Dr.).
firstName
String
firstName
Customer’s first name.
middleName
String
middleName
Customer’s middle name, if applicable.
lastName
String
lastName
Customer’s last name.
suffix
String
N/A
Suffix for the customer's name (e.g., Jr., Sr., III).
title
String
title
Job title of the customer, applicable if the customer is an individual.
String
Primary email address of the customer.
website
String
url
Customer’s company website URL.
phoneNumbers
PhoneNumber [ ]
list(PhoneNumber, [ rec.phone, rec.mobilePhone, rec.homePhone ])
List of phone numbers associated with the customer.
View PhoneNumber Properties
type
phone -> "unknown" mobilePhone -> "mobile" homePhone -> "home"
Phone number type
phoneNumber
Phone number
addresses
Address [ ]
list(Address, [ pick(entityAddresses, "id", rec.defaultShippingAddress), pick(entityAddresses, "id", rec.defaultBillingAddress) ])
List of addresses associated with the customer.
View Address Properties
id
String
nkey
Unique identifier for the address in NetSuite.
addressType
String
"shipping" | "billing"
Address type for e.g. shipping or billing
addressText
String
addrtext
Formatted, human-readable full address
line1
String
addr1
The first line of the address (usually street address or PO Box).
line2
String
addr2
The second line of the address (e.g., apartment, suite, or unit number).
line3
String
N/A
The third line of the address (optional, often used for additional info).
city
String
city
The city where the address is located.
state
String
state
The state or province of the address.
postalCode
String
zip
The ZIP or postal code for the address.
country
String
country
The country of the address in a standardized format
checkName
String
printOnCheckAs
Name to be printed on checks for the customer.
parentId
String
parent
Unique identifier of the parent customer, if applicable.
parentName
String
pick(customers, "id", rec.parent, "name")
Name of the parent customer, if applicable.
paymentMethod
String
N/A
Preferred payment method of the customer.
categoryId
String
category
Unique identifier for the customer category.
categoryName
String
pick(customerCategories, "id", rec.category, "name")
Name of the customer category.
taxable
Boolean
N/A
Indicates whether the customer is subject to taxation (true or false).
taxCode
String
N/A
Default tax code applied to the customer’s transactions.
salesRepId
String
salesRep
Unique identifier of the salesperson managing this customer.
salesRepName
String
pick(salesReps, "id", salesRep, "name")
Name of the salesperson managing this customer.
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
Unique identifier of the default currency associated with the customer.
currencyName
String
pick(currencies, "id", rec.currency, "name")
Full name of the default currency (e.g., "US Dollar", "Euro").
subsidiaryId
String
subsidiary
Unique identifier of the subsidiary associated with the customer.
subsidiaryName
String
pick(subsidiaries, "id", subsidiary, "name")
Name of the primary subsidiary associated with the customer.
customFields
CustomField [ ]
list( CustomField, pickRegex(rec, 'cust[.]*') )
Additional fields for storing extra customer details.
View CustomField Properties
name
{ "custentity_[field_id]": "Direct" } -> "custentity_[field_id]"
id of the custom field attribute
value
{ "custentity_[field_id]": "Direct" } -> "Direct"
Value of custom field
notes
String
N/A
Notes or comments related to the customer.
isActive
Boolean
NOT isinactive
Indicates whether the customer is currently active (true or false).
updatedAt
Datetime
lastmodifieddate
Timestamp indicating when the customer record was last updated.
createdAt
Datetime
dateCreated
Timestamp indicating when the customer record was created.
hgTenantId
String
{{tenantId}}
Unique identifier of the tenant or company that owns the customer record.
NetSuite
Example
{
"id":"9136",
"externalId":"C_200",
"companyName":"Coty",
"email":"Coty@dmail.com",
"website":"https://www.Coty.com",
"phoneNumbers":[
{
"type":"unknown",
"phoneNumber":"+18888665555"
},
{
"type":"mobile",
"phoneNumber":"+18888774445"
},
{
"type":"home",
"phoneNumber":"+14444665555"
}
],
"addresses":[
{
"id":"9443",
"addressType":"billing",
"addressText":"23 King St West NY - Billing",
"line1":"23 King St West NY",
"line2":"line2",
"line3":null,
"city":"New York",
"state":"NY",
"postalCode":"19123",
"country":"US"
},
{
"id":"9442",
"addressType":"shipping",
"addressText":"350 5th Avenue NY - Shipping",
"line1":"350 5th Avenue NY",
"line2":"line2",
"line3":null,
"city":"New York",
"state":"NY",
"postalCode":"19123",
"country":"US"
}
],
"parentId":"5133",
"parentName":"DAS Bootleg",
"categoryId":"Customer category 1",
"categoryName":"Customer category 1",
"salesRepId":"2526",
"salesRepName":"Dean Nasseri",
"currencyId":"1",
"currency":"USD",
"currencyName":"US Dollar",
"customFields":[
{
"name": "custentity1",
"value": Hello
},
{
"name": "custentity3",
"value": 12
},
{
"name": "custentity_ste_vendor_stecode",
"value": "100"
}
],
"subsidiaryId":"1",
"subsidiaryName":"Parent Company",
"isPerson":false,
"isActive":true,
"updatedAt":"2025-03-15T00:00:00.000000Z",
"createdAt":"2025-03-15T00:00:00.000000Z",
"hgTenantId":"default"
}Department(Departments)
Parameters
id
String
id
Unique identifier for the department.
externalId
String
externalId
Unique identifier for the department in an external system.
departmentCode
String
N/A
Unique internal code or number assigned to the department.
name
String
name
Descriptive name of the department (e.g., "Lead Generation" "Marketing," "Immigration").
fullname
String
fullname
Full name of the department, potentially combining name with other relevant data (e.g., "Human Resource : Immigration").
parentId
String
parent
The unique identifier of the parent department.
parentName
String
pick(departments, "id", rec.parent, ["id", "name"])
Includes key details about parent department. {id, name}
subsidiary
String [ ]
subsidiary.split(",")
An array of id(s) representing the subsidiaries associated with the department.
subsidiaryRef
Object [ ]
pick(subsidiaries, "id", rec.subsidiary.split(","), ["id", "name"])
An array of objects, includes key details about subsidiary. {id, name}
isActive
Boolean
NOT isinactive
Indicates current status of the department, Active. Deleted, Unknown
updatedAt
Datetime
N/A
Timestamp of the last update made to the department.
createdAt
Datetime
--UNAVAILABLE_IN_NETSUITE--
Timestamp of when the department was created.
hgTenantId
String
{tenantId}
Identifier for the tenant to which the department belongs.
NetSuite
Example
{ "id":"5",
"externalId":"sales-12",
"name":"Sales",
"fullname":"Information technology : Sales",
"parentId":"3",
"parentName":"Information technology",
"subsidiary":[
"1",
"2",
"3",
"4"
],
"subsidiaryRef":[
{
"id":"2",
"name":"California"
},
{
"id":"4",
"name":"New York"
},
{
"id":"1",
"name":"Parent Company"
},
{
"id":"3",
"name":"Virginia"
}
],
"isActive":true,
"updatedAt":"2025-02-25T00:00:00.000000Z",
"hgTenantId":true
}GeneralLedgerReport(GeneralLedgerReport)
Parameters
id
String
(Transaction.id || '_' || TransactionLine.id)
Unique identifier for the transaction entry.
accountName
String
Account.accountsearchdisplayname
Name of the account associated with the transaction.
fullyQualifiedAccountName
String
Account.displaynamewithhierarchy
Full hierarchical account name, including parent-child structure.
accountType
String
Account.AcctType
Type of the account (e.g., Asset, Liability, Revenue, Expense).
accountNumber
String
Account.acctnumber
Unique number assigned to the account.
accountId
String
Account.id
System-generated unique identifier for the account.
entityName
String
Entity.altname
Name of the entity (e.g., customer, vendor) related to the transaction.
entityFirstName
String
Entity.firstname
First name of the entity (if applicable, e.g., an individual customer).
entityLastName
String
Entity.lastname
Last name of the entity (if applicable).
entityId
String
Entity.id
Unique identifier for the entity.
entityType
String
Entity.Type
Type of entity (e.g., Customer, Vendor, Employee).
externalId
String
Transaction.tranid
External system reference ID for the transaction or entity.
transactionType
String
Transaction.abbrevtype
Type of transaction (e.g., Invoice, Payment, Journal Entry).
transactionDate
Datetime
TO_CHAR (Transaction.TranDate, 'YYYY-MM-DD HH24:MI:SS')
Date when the transaction was recorded.
transactionNumber
String
Transaction.transactionnumber
Unique number assigned to the transaction.
tranDisplayName
String
Transaction.trandisplayname
Display-friendly transaction name or reference.
memo
String
TransactionLine.memo
Additional notes or details about the transaction.
entryType
String
CASE WHEN TransactionAccountingLine.credit IS NOT NULL THEN 'Credit' ELSE 'Debit' END
Indicates whether the transaction is a "Credit" or "Debit".
creditAmount
Number
TransactionAccountingLine.credit
Amount recorded as a credit in the transaction.
debitAmount
Number
TransactionAccountingLine.debit
Amount recorded as a debit in the transaction.
departmentId
String
department.id
Unique identifier for the department associated with the transaction.
departmentName
String
department.fullname
Name of the department related to the transaction.
locationId
String
TransactionLine.location
Unique identifier for the location associated with the transaction.
locationName
String
Location.name
Name of the location related to the transaction.
currencyId
String
Transaction.currency currencyId,
Unique identifier for the currency used in the transaction.
currencyName
String
Currency.name
Name of the currency (e.g., US Dollar, Euro).
currency
String
Currency.symbol
ISO 3-letter currency code (e.g., USD, EUR).
exchangeRate
Number
TransactionAccountingLine.exchangeRate
Exchange rate applied if the transaction involves currency conversion.
subsidiaryId
String
TransactionLine.subsidiary
Unique identifier for the subsidiary related to the transaction.
subsidiaryName
String
Subsidiary.fullname
Name of the subsidiary company.
classId
String
Classification.id
Unique identifier for the classification associated with the transaction.
className
String
Classification.name
Name of the classification (used for reporting purposes).
postingPeriod
String
Transaction.postingPeriod
Accounting period in which the transaction is recorded.
periodName
String
AccountingPeriod.PeriodName
Name of the posting period (e.g., "Jan 2025").
periodStartDate
Datetime
TO_CHAR (AccountingPeriod.StartDate, 'YYYY-MM-DD HH24:MI:SS' )
Start date of the accounting period.
periodEndDate
Datetime
TO_CHAR (AccountingPeriod.EndDate, 'YYYY-MM-DD HH24:MI:SS' )
End date of the accounting period.
NetSuite
Example
{ "id": "170_1",
"accountName": "Expenses",
"fullyQualifiedAccountName": "Expenses",
"accountType": "Expense",
"accountNumber": "6000",
"accountId": "58",
"entityName": "Leonard Building & Truck Acc.",
"entityId": "14",
"entityType": "Vendor",
"externalId":"GL-12",
"transactionType": "BILL",
"transactionDate": "2024-10-21T00:00:00.000000Z",
"transactionNumber": "VENDBILL94",
"tranDisplayName": "Bill #TEST70",
"memo": "3rd Party Services",
"entryType": "Debit",
"creditAmount": 0.0,
"debitAmount": 730.0,
"departmentId": "3",
"departmentName": "Information technology",
"locationId": "6",
"locationName": "COLOMBIA",
"currencyId": "1",
"currencyName": "US Dollar",
"currency": "USD",
"exchangeRate": "1",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"classId": "3",
"className": "Project 3",
"postingPeriod": "15",
"periodName": "Oct 2024",
"periodStartDate": "2024-10-01T00:00:00.000000Z",
"periodEndDate": "2024-10-31T00:00:00.000000Z"
}Invoice(Invoices)
Parameters
id
String
id
Unique identifier for the invoice
invoiceNumber
String
transactionNumber
Internal reference number for tracking the invoice.
externalId
String
externalId | tranid
ID from an external system, if applicable.
customerId
String
entity
The customer associated with the invoice.
customerName
String
pick(vendors, "id", rec.entity, "name")
Key details about customer. {id, name}
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
Unique identifier for the currency.
currencyName
String
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
exchangeRate
Number
exchangerate
Exchange rate applied.
status
String
BUILTIN.DF(t.Status)
Current status of the invoice
issueDate
Datetime
trandate
The date when the invoice was issued.
dueDate
Datetime
duedate
The date by which the invoice is due.
paidDate
Datetime
max(paymentDates) from invoicePayments
The date on which this invoice was marked as paid
shipDate
Datetime
addresses
Address [ ]
list(Address, [ pick(transactionAddresses, "id", rec.billingAddress), pick(transactionAddresses, "id", rec.shippingAddress) ])
Transaction's addresses.
View Address Properties
id
String
nkey
Unique identifier for the address in NetSuite.
addressType
String
"shipping" | "billing"
Address type for e.g. shipping or billing
addressText
String
addrtext
Formatted, human-readable full address
line1
String
addr1
The first line of the address (usually street address or PO Box).
line2
String
addr2
The second line of the address (e.g., apartment, suite, or unit number).
line3
String
N/A
The third line of the address (optional, often used for additional info).
city
String
city
The city where the address is located.
state
String
state
The state or province of the address.
postalCode
String
zip
The ZIP or postal code for the address.
country
String
country
The country of the address in a standardized format
taxAmount
Number
taxTotal
Total tax applied to this invoice
discountAmount
Number
N/A
Discount applied to this invoice
subtotal
Number
foreigntotal - taxtotal
The total amount of the invoices before taxes.
totalAmount
Number
foreigntotal
The total amount of the invoice including tax.
balance
Number
foreignamountunpaid
The outstanding balance remaining on the invoice.
locationId
String
N/A
The location associated with the invoice.
locationName
String
N/A
Key details about location {id, name}
customFields
CustomField [ ]
list( CustomField, pickRegex(rec, 'cust[.]*') )
Additional metadata or custom attributes.
View CustomField Properties
name
{ "custentity_[field_id]": "Direct" } -> "custentity_[field_id]"
id of the custom field attribute
value
{ "custentity_[field_id]": "Direct" } -> "Direct"
Value of custom field
lineItems
InvoiceLineItem [ ]
list(InvoiceLineItem, pick(transactionLine, "transaction", rec.id))
List of individual items included in the invoice.
View InvoiceLineItem Properties
id
String
id
A unique identifier for the transaction line, typically auto-generated by the system.
invoiceId
String
transaction
The reference ID of the parent invoice to which this transaction line belongs.
itemId
String
item
A unique identifier for the specific product, service, or item involved in the transaction line, typically assigned by the system.
itemName
String
pick(items, "id", rec.item, "name")
The name or description of the item in the transaction, which can include details like item type, model, or specific attributes associated with the item.
accountId
String
N/A
The unique identifier for the financial account linked to the transaction line, such as a sales or expense account.
accountName
String
N/A
The name of the account associated with the transaction line, which might include general ledger account names such as 'Sales' or 'Expenses.'
description
String
memo
A text field providing additional information about the transaction line, such as specifications, notes, or special handling instructions.
taxCode
String
N/A
A tax classification code applied to the transaction, used to calculate the applicable tax based on predefined tax rules.
discount
Number
N/A
The amount or percentage discount applied to the transaction line, reducing the total price before tax.
quantity
Number
quantity
The number of units of the product or service being transacted in this line.
unitPrice
Number
rate
The price per individual unit of the item or service in the transaction line before any discount or tax.
totalPrice
Number
netamount
The total price for the transaction line, calculated by multiplying the unit price by the quantity, after applying any discounts and taxes.
serviceDate
Datetime
N/A
The date on which the service was provided or the item was delivered, if relevant to the transaction.
customFields
CustomField [ ]
list( CustomField, pickRegex(rec, 'cust[.]*') )
Custom user-defined fields for additional data storage, such as customer-specific or transaction-specific details not covered by other fields.
View CustomField Properties
name
{ "custentity_[field_id]": "Direct" } -> "custentity_[field_id]"
id of the custom field attribute
value
{ "custentity_[field_id]": "Direct" } -> "Direct"
Value of custom field
classId
String
class
The unique identifier for the classification or category of the transaction, used for detailed reporting and financial categorization.
className
String
pick(classes, "id", rec.class, "name")
The name or reference to the classification of the transaction, which could include categories like 'Product Sales' or 'Service Revenue'.
locationId
String
location
The unique identifier for the physical or operational location associated with the transaction line (e.g., store or warehouse).
locationName
String
pick(locations, "id", rec.location, "name")
The name of the location associated with the transaction line, often linked to an external system representing the operational site.
departmentId
String
department
The unique identifier for the department within the organization responsible for the transaction line.
departmentName
String
pick(departments, "id", rec.department, "name")
The name of the department involved in the transaction, such as 'Sales' or 'Marketing,' used for internal categorization.
notes
String [ ]
N/A
Any additional notes or comments.
attachments
String [ ]
N/A
Supporting documents related to the invoice.
InvoicePayments [ ]
list(InvoicePayments, pick(invoicePayments, "transaction", rec.id))
Payment associated with this invoice
View InvoicePayments Properties
invoiceId
String
invoice.id
The reference ID of the invoice associated with the payment.
id
String
id
The unique identifier for the payment transaction related to the invoice.
paymentTransactionNumber
String
transactionNumber
Internal reference number for tracking the customer payment.
externalId
String
externalId | tranid
ID from an external system, if applicable.
paymentDate
Datetime
tranDate
The date when the payment was made or recorded for the bill.
paymentStatus
String
BUILTIN.DF(Status)
The status of the payment, indicating whether the payment has been completed.
amount
Number
amount
The total amount of the payment made towards the invoice, typically reflecting the full or partial payment.
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
Unique identifier for the currency.
currencyName
String
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
exchangeRate
Number
exchangeRate
The exchange rate applied for conversion to base currency.
accountId
String
Unique ID of GL account associated with this payment
The account associated with the transaction line, typically reflecting the ledger account involved in the financial transaction (e.g., Sales, Expense).
accountName
String
Name of GL account associated with this payment
A reference to the account, including key details such as account ID, name, and other account-related attributes.
subsidiaryId
String
subsidiary
The unique identifier for the subsidiary within a larger corporate structure associated with the transaction line.
subsidiaryName
String
pick(subsidiary, "id", rec.subsidiary, "name")
The name of the subsidiary, often representing a specific branch or division of the company, such as 'Subsidiary A' or 'East Coast Operations.'
createdAt
Datetime
createddate
Timestamp when the invoice was created.
updatedAt
Datetime
lastmodifieddate
Timestamp when the invoice was last updated.
hgTenantId
String
{tenantId}
Identifier for the HotGlue tenant associated with the invoice.
NetSuite
Example
{}Item(Items)
Parameters
id
String
id
Unique identifier for the item.
externalId
String
externalId
Unique identifier for the item in an external system.
name
String
fullName
Name of the item.
code
String
itemId
A unique code assigned to the item for easy reference.
displayName
String
displayName
Name displayed for the item, typically user-friendly.
type
String
itemType
Type or classification of the item.
category
String
subtype
Category to which the item belongs. (e.g. Sale, Resale, Purchase)
isBillItem
Boolean
subttype in ("Purchase" , "Resale")
Indicates whether the item is associated with bills and can be purchased.
itemVendors
ItemVendor [ ]
list(ItemVendor, pick(itemVendors, "item", rec.id))
Lists of all vendors who stocks this item.
View ItemVendor Properties
vendorItemCode
String
vendorCode
The vendor's unique identifier or code for the item.
vendorId
String
vendor
Unique identifier of the vendor associated with the item.
vendorName
String
pick(vendors, "id", rec.vendor, "name")
Name of the vendor associated with the item.
itemCost
Number
vendorcost
The cost of the item when purchased from the vendor.
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
The unique identified for the currency
currencyName
String
pick(currencies, "id", rec.currency, "name")
The full name of the currency
isPreferredVendor
Boolean
preferredVendor
Indicates if the vendor is marked as the preferred supplier.
isInvoiceItem
Boolean
subttype in ("Sale" , "Resale")
Indicates whether the item is associated with invoices and can be sold.
itemVariants
Array(ItemVariable)
list(ItemVariant, pick(itemPrices, "item", rec.id))
All price variants for this item.
quantityOnHand
Number
totalQuantityOnHand
The current stock quantity available for the item.
accounts
ItemAccount [ ]
list(ItemAccount, [ pick(accounts, "id", rec.assetAccount), pick(accounts, "id", rec.incomeAccount), pick(accounts, "id", rec.expenseAccount) ])
Item's GL Account
classId
String
class
Unique identifier for the class associated with the item
className
String
pick(classes, "id", rec.class, "name")
Name of the class.
departmentId
String
department
Unique identifier for the department associated with the item.
departmentName
String
pick(departments, "id", rec.department, "name")
Name of the department associated with the item.
locationId
String
location
Unique identifier location associated with this item
locationName
String
pick(locations, "id", rec.location, "name")
Name of the location associated with the account.
subsidiary
String
subsidiary.split(",")
Array of unique identifiers representing the subsidiaries associated with the item.
subsidiaryRef
String
pick(subsidiaries, "id", rec.subsidiary.split(","), ["id", "name"])
Array of objects containing details of the subsidiaries in the format {id, name}.
isActive
Boolean
NOT isinactive
Indicates whether the item is currently active (true or false).
updatedAt
Datetime
lastModifiedDate
Timestamp of the last update made to the item.
createdAt
Datetime
createdDate
Timestamp of when the item was created.
hgTenantId
String
{tenantId}
Identifier for the tenant or account to which the item belongs.
NetSuite
Example
{
"id":"1311",
"externalId":"EXT-900",
"name":"77777",
"code":"77777",
"displayName":"nonInventoryPurchaseItem",
"type":"NonInvtPart",
"category":"Purchase",
"classId":"2",
"className":"Project 2",
"departmentId":"6",
"departmentName":"Accounting and finance",
"locationId":"3",
"locationName":"USA",
"isBillItem":true,
"itemVendors":[
{
"vendorItemCode":null,
"vendorId":"8936",
"vendorName":"Abbot",
"itemCost":10.0,
"currencyId":"1",
"currency":"USD",
"currencyName":"US Dollar",
"isPreferredVendor":true
}
],
"isInvoiceItem":false,
"locationId":"9",
"locationName":"EMEA",
"accounts": [
{
"accountType": "asset",
"id": "312",
"accountNumber": "6000",
"name": "asset"
}
],
"subsidiary":[
"1"
],
"subsidiaryRef":[
{
"id":"1",
"name":"Parent Company"
}
],
"isActive":true,
"updatedAt":"2025-03-18T00:00:00.000000Z",
"createdAt":"2025-02-24T00:00:00.000000Z",
"hgTenantId":"default"
}JournalEntry(JournalEntries)
Parameters
id
String
id
Unique identifier for the invoice
externalId
String
externalId & tranid
ID from an external system, if applicable.
transactionDate
Datetime
tranDate
Date at which transaction is effective
description
String
memo
Brief description of this Journal Entry, usually a small memo
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
Unique identifier for the currency.
currencyName
String
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
classId
String
class
Categorizes transactions or records for detailed reporting
className
String
pick(classes, "id", rec.class, "name")
Includes key details about class. {id, name}
exchangeRate
Number
exchangeRate
Exchange rate applied if the journal entry is in a foreign currency.
departmentId
String
department
The organizational unit within the company
departmentName
String
pick(departments, "id", rec.department, "name")
Name if the organization unit.
locationId
String
location
Specifies the physical or geographical location where a transaction occurred
locationName
String
pick(locations, "id", rec.location, "name")
Name of the location.
subsidiaryId
String
subsidiary
Unique Id of the subsidiary associated with the journal entry.
customFields
CustomField [ ]
list( CustomField, pickRegex(rec, 'cust[.]*') )
Custom attributes related to the journal entry.
View CustomField Properties
name
{ "custentity_[field_id]": "Direct" } -> "custentity_[field_id]"
id of the custom field attribute
value
{ "custentity_[field_id]": "Direct" } -> "Direct"
Value of custom field
postingPeriod
String
postingPeriod
Accounting Period in which this Journal Entry will be posted
lineItems
JournalEntryLineItem [ ]
line
List of individual items included in the journal entry.
View JournalEntryLineItem Properties
accountId
String
Account.id
Unique identifier for the account.
accountName
String
Account.accountsearchdisplayname
Name of the account associated with the line item.
accountNumber
String
Account.acctnumber
Unique number assigned to the account.
classId
String
class
Categorizes transactions or records for detailed reporting
className
String
pick(classes, "id", rec.class, "name")
Includes key details about class. {id, name}
departmentId
String
department
The organizational unit within the company
departmentName
String
pick(departments, "id", rec.department, "name")
Name if the organization unit.
locationId
String
location
Specifies the physical or geographical location where a transaction occurred
locationName
String
pick(locations, "id", rec.location, "name")
Name of the location.
customerId
String
entity.id or entity.externalId
The customer associated with the line item.
customerName
String
pick(locations, "id", rec.location, "name")
Name of customer associated with the line item
vendorId
String
entity.id or entity.externalId
The vendor associated with the line item.
vendorName
String
Name of vendor associated with the line item
description
String
memo
Brief description of the line item, memo.
creditAmount
Number
credit
Amount recorded as a credit in the line item.
debitAmount
Number
debit
Amount recorded as a debit in the line item.
entryType
String
IF ABS(rec.credit) IS NOT NULL THEN 'Credit' ELSE 'Debit' END
Indicates whether the line item is a "Credit" or "Debit".
subsidiaryName
String
pick(subsidiaries, "id", rec.subsidiary, "name")
Name of the subsidiary associated with the journal entry.
hgTenantId
String
{tenantId}
Identifier for the HotGlue tenant associated with the journalEntry.
NetSuite
Example
{
"externalId": "TEST-JL-213",
"description": "TEST-JL-213",
"classId": "1",
"locationId": "1",
"departmentId": "5",
"subsidiaryId": "1",
"currency": "USD",
"transactionDate": "2025-03-18T00:00:00Z",
"postingPeriod": "23",
"hgTenantId": "TENANT-123",
"exchangeRate": 1.0,
"customFields": [
{
"name": "custbodycust_je_cf_test",
"value": "CF test value"
},
{
"name": "custbody3",
"value": true
}
],
"lineItems": [
{
"accountId": "1",
"description": "TEST-JL-213",
"classId": "1",
"locationId": "1",
"departmentId": "5",
"entryType": "Credit",
"creditAmount": 22,
"customerId": "3"
},
{
"accountId": "58",
"description": "TEST-JL-212",
"classId": "1",
"locationId": "1",
"departmentId": "5",
"entryType": "Debit",
"debitAmount": 22
}
]
}Location(Locations)
Parameters
id
String
id
Unique identifier for the location.
externalId
String
externalId
Unique identifier for the location in an external system.
locationNumber
String
N/A
Unique internal code or number assigned to the location.
name
String
name
Descriptive name of the location (e.g., "New York," "Africa").
fullname
String
fullname
Full name of the location, e.g. combined with parent name or other relevant data.
addresses
Address [ ]
list(Address, [ pick(entityAddresses, "id", rec.mainAddress), pick(entityAddresses, "id", rec.returnAddress) ])
Collection of address information for the location (e.g., shipping, billing).
View Address Properties
id
String
nkey
Unique identifier for the address in NetSuite.
addressType
String
"shipping" | "billing"
Address type for e.g. shipping or billing
addressText
String
addrtext
Formatted, human-readable full address
line1
String
addr1
The first line of the address (usually street address or PO Box).
line2
String
addr2
The second line of the address (e.g., apartment, suite, or unit number).
line3
String
N/A
The third line of the address (optional, often used for additional info).
city
String
city
The city where the address is located.
state
String
state
The state or province of the address.
postalCode
String
zip
The ZIP or postal code for the address.
country
String
country
The country of the address in a standardized format
parentId
String
parent
The unique identifier of the parent location.
parentName
String
pick(locations, "id", rec.parent, ["id", "name"])
Includes key details about parent location. {id, name}
locationType
String
locationType
Unique identifier of the location type.
locationTypeName
String
pick(locationTypes, "id", rec.parent, "name")
Name of the location type
currency
String
N/A
Primary currency used for financial transactions at this location.
subsidiary
String
subsidiary.split(",")
An array of id(s) representing the subsidiaries associated with the location.
subsidiaryRef
String
pick(subsidiaries, "id", rec.subsidiary.split(","), ["id", "name"])
An array of objects, includes key details about subsidiary. {id, name}
isActive
Boolean
NOT isinactive
Indicates current status of the location, Active. Deleted, Unknown
updatedAt
Datetime
lastModifiedDate
Timestamp of the last update made to the location.
createdAt
Datetime
--UNAVAILABLE_IN_NETSUITE--
Timestamp of when the location was created.
hgTenantId
String
{tenantId}
Identifier for the tenant to which the location belongs.
NetSuite
Example
{
"id":"3",
"externalId":"USA-location",
"name":"USA",
"fullname":"NOAM : USA",
"addresses":[
{
"id":"4",
"addressType":"main",
"addressText":"1234 Main St\r\nLittle Rock AR AR 72201\r\nUnited States",
"line1":"1234 Main St",
"line2":null,
"line3":null,
"city":"Little Rock",
"state":"AR",
"postalCode":"AR 72201",
"country":"US"
},
{
"id":"3832",
"addressType":"return",
"addressText":"5678 Desert Rd\r\nPhoenix AZ AZ 85001\r\nUnited States",
"line1":"5678 Desert Rd",
"line2":null,
"line3":null,
"city":"Phoenix",
"state":"AZ",
"postalCode":"AZ 85001",
"country":"US"
}
],
"parentId":"1",
"parentName":"NOAM",
"locationType":"1",
"locationTypeName":"NOAM",
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"subsidiary":"1",
"subsidiaryRef":{
"id":"1",
"name":"Parent Company"
},
"isActive":false,
"updatedAt":"2025-02-25T00:00:00.000000Z",
"hgTenantId":true
}Subsidiary(Subsidiaries)
Parameters
id
String
id
Unique identifier for the subsidiary.
externalId
String
externalId
Unique identifier for the subsidiary in an external system.
name
String
name
Name of the subsidiary (e.g., "California," "European Branch").
fullname
String
fullname
Full name of the subsidiary, potentially combining name with other relevant data (e.g., "USA : California").
addresses
Address [ ]
list(Address, [ pick(entityAddresses, "id", rec.mainAddress), pick(entityAddresses, "id", rec.returnAddress), pick(entityAddresses, "id", rec.shippingAddress), ])
Collection of address information for the subsidiary (e.g., main address, shipping address, return address).
View Address Properties
id
String
nkey
Unique identifier for the address in NetSuite.
addressType
String
"shipping" | "billing"
Address type for e.g. shipping or billing
addressText
String
addrtext
Formatted, human-readable full address
line1
String
addr1
The first line of the address (usually street address or PO Box).
line2
String
addr2
The second line of the address (e.g., apartment, suite, or unit number).
line3
String
N/A
The third line of the address (optional, often used for additional info).
city
String
city
The city where the address is located.
state
String
state
The state or province of the address.
postalCode
String
zip
The ZIP or postal code for the address.
country
String
country
The country of the address in a standardized format
String
Primary email address for this subsidiary.
state
String
state
The state or province in which this subsidiary is located.
website
String
url
Subsidiary's website address, or URL.
parentId
String
parent
The unique identifier of the parent subsidiary.
parentName
String
pick(subsidiaries, "id", rec.parent, "name")
Includes key details about parent subsidiary. {id, name}
currencyId
String
currency
The unique identifier of the currency.
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyName
String
pick(currencies, "id", rec.currency, "name")
Includes key details about currency. {id, name, symbol}
isActive
Boolean
NOT isinactive
Indicates current status of the subsidiary, Active. Deleted, Unknown
updatedAt
Datetime
lastModifiedDate
Timestamp of the last update made to the subsidiary.
createdAt
Datetime
--UNAVAILABLE_IN_NETSUITE--
Timestamp of when the subsidiary was created.
hgTenantId
String
{tenantId}
Identifier for the tenant to which the subsidiary belongs.
NetSuite
Example
{
"id":"4",
"name":"New York",
"fullname":"Parent Company : New York",
"addresses":[
{
"id":"9235",
"addressType":"main",
"addressText":"721 Broadway\r\nWashington Square South\r\nNY \r\nUnited States",
"line1":null,
"line2":null,
"line3":null,
"city":null,
"state":"NY",
"postalCode":null,
"country":"US"
},
{
"id":"9237",
"addressType":"return",
"addressText":"119 W 23rd St, \r\nNew York, NY 10011\r\nNY \r\nUnited States",
"line1":null,
"line2":null,
"line3":null,
"city":null,
"state":"NY",
"postalCode":null,
"country":"US"
},
{
"id":"9236",
"addressType":"shipping",
"addressText":"244 5th Ave Suite 2212\r\nNew York, NY 10001\r\nNY \r\nUnited States",
"line1":null,
"line2":null,
"line3":null,
"city":null,
"state":"NY",
"postalCode":null,
"country":"US"
}
],
"email":"NY@hotglue.xyz",
"state":"NY",
"website":"www,hotglueqa.com",
"parentId":"1",
"parentName":"Parent Company",
"currencyId":"1",
"currency":"USD",
"currencyName":"US Dollar",
"isActive":true,
"updatedAt":"2025-03-13T00:00:00.000000Z",
"hgTenantId":"default"
}TrialBalanceReport(TrialBalanceReport)
Parameters
accountId
String
System-generated unique identifier for the account.
accountNumber
String
Unique number assigned to the account.
accountName
String
Name of the account associated with the transaction.
fullyQualifiedAccountName
String
Full hierarchical account name, including parent-child structure.
accountType
String
Type of the account (e.g., Asset, Liability, Revenue, Expense).
postingPeriod
String
Accounting period in which the transaction is recorded.
periodName
String
Name of the posting period (e.g., "Jan 2025").
periodStartDate
Datetime
Start date of the accounting period.
periodEndDate
Datetime
End date of the accounting period.
beginningBalance
Number
Represents the account balance at the start of each period.
creditAmount
Number
Amount recorded as a credit in the transaction.
debitAmount
Number
Amount recorded as a debit in the transaction.
endingBalance
Number
Represents the account balance at the end of each period.
currencyId
String
Unique identifier for the currency used in the transaction.
currencyName
String
Name of the currency (e.g., US Dollar, Euro).
currency
String
ISO 3-letter currency code (e.g., USD, EUR).
subsidiaryId
String
Unique identifier for the subsidiary related to the transaction.
subsidiaryName
String
Name of the subsidiary company.
NetSuite
Example
{
"accountId": "58",
"accountNumber": "6000",
"accountName": "Expenses",
"fullyQualifiedAccountName": "Expenses",
"accountType": "Expense",
"postingPeriod": "2025-03",
"periodName": "Mar 2025",
"periodStartDate": "2025-03-01T00:00:00.000000Z",
"periodEndDate": "2025-03-31T00:00:00.000000Z",
"beginningBalance": 100233.78002929688,
"creditAmount": 60.0,
"debitAmount": 60.0,
"endingBalance": 100233.78002929688,
"currencyId": "1",
"currencyName": "US Dollar",
"currency": "USD",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company"
}Vendor(Vendors)
Parameters
id
String
id
Unique identifier for the vendor in the system. Serves as the primary key for internal referencing.
externalId
String
externalId
External reference ID used to link the vendor with external systems.
isPerson
Boolean
isPerson
True if this customer is an individual, and not a company.
vendorName
String
companyName
Official name of the vendor's company.
fullName
String
--UNAVAILABLE_IN_NETSUITE--
Full name of the vendor, including first, middle, and last names.
prefix
String
salutation
Title preceding the vendor’s name (e.g., Mr., Ms., Dr.).
firstName
String
firstName
Vendor's first name.
middleName
String
middleName
Vendor's middle name, if applicable.
lastName
String
lastName
Vendor's last name.
suffix
String
--UNAVAILABLE_IN_NETSUITE--
Any suffix for the vendor's name (e.g., Jr., Sr., III).
title
String
title
Job title of the vendor, applicable if the vendor is an individual.
String
Vendor's primary email address.
website
String
url
Vendor's website URL.
phoneNumbers
PhoneNumber [ ]
list(PhoneNumber, [ rec.phone, rec.mobilePhone, rec.homePhone ])
List of phone numbers associated with the vendor.
View PhoneNumber Properties
type
phone -> "unknown" mobilePhone -> "mobile" homePhone -> "home"
Phone number type
phoneNumber
Phone number
addresses
Address [ ]
list(Address, [ pick(entityAddresses, "id", rec.defaultShippingAddress), pick(entityAddresses, "id", rec.defaultBillingAddress) ])
List of addresses associated with the vendor.
View Address Properties
id
String
nkey
Unique identifier for the address in NetSuite.
addressType
String
"shipping" | "billing"
Address type for e.g. shipping or billing
addressText
String
addrtext
Formatted, human-readable full address
line1
String
addr1
The first line of the address (usually street address or PO Box).
line2
String
addr2
The second line of the address (e.g., apartment, suite, or unit number).
line3
String
N/A
The third line of the address (optional, often used for additional info).
city
String
city
The city where the address is located.
state
String
state
The state or province of the address.
postalCode
String
zip
The ZIP or postal code for the address.
country
String
country
The country of the address in a standardized format
checkName
String
printOnCheckAs
Name to print on checks for the vendor.
balance
Number
balance
Vendor's current accounts payable balance.
balanceDate
Datetime
{{current_timestamp}}
Date when the balance was last synchronized from the system.
categoryId
String
category
Unique identifier for the vendor's category.
categoryName
String
pick(vendorCategories, "id", rec.category, "name")
Name of the vendor's category.
currency
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
currency
Unique identifier of the currency associated with the customer.
currencyName
String
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
subsidiaryId
String
subsidiary
Unique identifier of the subsidiary associated with the vendor.
subsidiaryName
String
pick(subsidiaries, "id", subsidiary, "name")
Name of the subsidiary associated with the vendor.
customFields
CustomField [ ]
list( CustomField, pickRegex(rec, 'cust[.]*') )
Additional custom fields for storing extra vendor details.
View CustomField Properties
name
{ "custentity_[field_id]": "Direct" } -> "custentity_[field_id]"
id of the custom field attribute
value
{ "custentity_[field_id]": "Direct" } -> "Direct"
Value of custom field
isActive
Boolean
NOT isinactive
Boolean value indicating whether the vendor account is currently active.
updatedAt
Datetime
lastmodifieddate
Timestamp indicating when the vendor record was last updated.
createdAt
Datetime
dateCreated
Timestamp indicating when the vendor record was created.
hgTenantId
String
{{tenantId}}
Unique identifier for the tenant or company that owns the vendor record.
NetSuite
Example
{
"id":"8936",
"externalId":"AP_600",
"vendorName":"Abbot",
"fullName":"",
"email":"Abbot@doodle.com",
"website":"http://www.Abbot.com",
"phoneNumbers":[
{
"type":"unknown",
"phoneNumber":"+03311301929"
}
],
"addresses":[
{
"id":"9240",
"addressType":"billing",
"addressText":"AP\n7901 West Wood Blvd\nNorth Cumbria CA 90069\nUnited States",
"line1":"7901 West Wood Blvd",
"line2":null,
"line3":null,
"city":"North Cumbria",
"state":"CA",
"postalCode":"90069",
"country":"US"
},
{
"id":"9241",
"addressType":"shipping",
"addressText":"AP\n7902 East Wood Blvd\nSouth Wales NY 90070\nUnited States",
"line1":"7902 East Wood Blvd",
"line2":null,
"line3":null,
"city":"South Wales",
"state":"CA",
"postalCode":"90069",
"country":"US"
}
],
"balance":0.0,
"balanceDate":"2025-03-15T00:00:00.000000Z",
"categoryId":"Supplies",
"categoryName":"Supplies",
"currency":"USD",
"currencyId":"1",
"currencyName":"US Dollar",
"customFields":[
{
"name": "custentity1",
"value": Hello
},
{
"name": "custentity3",
"value": 12
},
{
"name": "custentity_ste_vendor_stecode",
"value": "100"
}
],
"subsidiaryId":"1",
"subsidiaryName":"Parent Company",
"isPerson":false,
"isActive":true,
"updatedAt":"2025-03-15T00:00:00.000000Z",
"createdAt":"2025-03-15T00:00:00.000000Z",
"hgTenantId":"default"
}