SCHEMAS
Introduction
Account
Bill
BillPayment
Class
Customer
Department
GeneralLedgerReport
Invoice
InvoicePayment
Item
JournalEntry
Location
PurchaseOrder
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.
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}.
subsidiaryId
String
subsidiary.id
Unique ID of the subsidiary associated with the account
subsidiaryName
String
subsidiary.name
Name of the subsidiary associated with the account
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.
hgTenantId
String
{{tenantId}}
Unique identifier of the tenant or company that owns the account.
isPosting
True if accttype not in ['Stat', 'NonPosting'] else False
Boolean field (true or false) indicating whether the account can be posted to.
NetSuite
Example
{
"id": "1720",
"externalId": "Interbank6733",
"name": "Bank account #35",
"fullyQualifiedName": "Cash : Bank account #35",
"description": "Bank account used for vendors",
"parentId": "1",
"parentName": "Cash",
"type": "Bank",
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar",
"isActive": true,
"subsidiary": [
"1"
],
"subsidiaryRef": [
{
"id": "1",
"name": "Parent Company"
}
],
"classId": "2",
"className": "Project 2",
"departmentId": "2",
"departmentName": "Information technology",
"locationId": "3",
"locationName": "USA",
"isBankAccount": true,
"isPosting": true,
"updatedAt": "2025-06-19T13:23:31.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.
billNumber
String
tranid | number
Bill number
externalId
String
externalId
ID from an external system, if applicable.
vendorId
String
entity
Unique identifier of the vendor associated with the bill.
vendorExternalId
String
pick(vendors, "id", rec.entity, "externalId")
Vendor ID from an external system, if applicable.
vendorNumber
String
pick(vendors, "id", rec.entity, "entityid")
A unique, typically human-readable code assigned to identify this vendor.
vendorName
String
pick(vendors, "id", rec.entity, "name")
Name of the vendor associated with the bill.
description
String
memo
Additional details or notes about the vendor 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.
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
Transaction date
paidDate
Datetime
enddate
Date when the bill was paid.
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
String
id
Unique identifier for the bill item, auto-generated by the system.
billId
String
transaction
Unique identifier of the bill or purchase order associated with this item.
itemId
String
item.id
Unique identifier of the product or service listed in the bill.
itemNumber
String
pick(items, "id", rec.item, "itemId")
Number of the product or service listed in the bill.
itemName
String
pick(items, "id", rec.item, "fullName")
Name of the product or service associated with the itemId.
description
String
memo
Additional details or notes about the item or service in this bill line.
quantity
Number
quantity
Number of units of the product or service in this bill line.
unitPrice
Number
rate
Price per unit of the product or service before applying discounts or taxes.
amount
Number
netamount
Total cost of this bill item, calculated as (unitPrice × quantity) after any discounts or taxes.
customFields
CustomField [ ]
pickRegex(rec, 'cust[.]*')
Additional metadata or custom attributes for this bill item.
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
Unique identifier for the classification of this transaction for reporting purposes.
className
String
pick(classes, "id", rec.class, "name")
Name of the classification
locationId
String
location
Unique identifier of the location associated with this bill item.
locationName
String
pick(locations, "id", rec.location, "name")
Name of the location linked to this bill item.
departmentId
String
department
Unique identifier of the department responsible for this bill item.
departmentName
String
pick(departments, "id", rec.department, "name")
Name of the department
taxAmount
Number
taxamount * -1
Tax applied to the line
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this item, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
expenses
BillExpense [ ]
list(BillExpense, pick(transactionLine, "transaction", rec.id))
Breakdown of expenses related to the bill.
View BillExpense Properties
id
String
id
The unique identifier for the transaction line, typically auto-generated by the system.
billId
String
transaction
The reference ID of the related bill or purchase order associated with the transaction line.
description
String
memo
A text field for providing additional details about the transaction line, such as notes or specifications about the item/service.
amount
Number
netamount
The total amount of the transaction line.
customFields
CustomField [ ]
pickRegex(rec, 'cust[.]*')
Additional custom 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
classId
String
class
Unique identifier for the classification of this transaction for reporting purposes.
className
String
pick(classes, "id", rec.class, "name")
Includes key details about class. {id, name}
locationId
String
location
Unique identifier of the location associated with this bill item.
locationName
String
pick(locations, "id", rec.location, "name")
Name of the location associated with the bill.
departmentId
String
department
Unique identifier of the department responsible for this bill item.
departmentName
String
pick(departments, "id", rec.department, "name")
Includes key details about department. {id, name}
subsidiaryId
String
subsidiary
id of the subsidiary
subsidiaryName
String
pick(subsidiary, "id", rec.subsidiary, "name")
Include key details about the primary subsidiary {id, name}
taxAmount
Number
taxamount * -1
Tax applied to the line
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this bill expense, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
taxLines
TaxLine [ ]
list(TaxLine, pick(taxlines, "transaction", rec.id)
Breakdown of taxes related to the bill.
View TaxLine Properties
id
String
id
Unique identifier for the customer within the system. Serves as the primary key.
taxCode
String
memo
Default tax code applied to the customer’s transactions.
taxAmount
Number
foreignamount * -1
Tax applied to the line
BillPayment [ ]
list(BillPayment, pick(billPayments, "transaction", rec.id))
Payments associated with settling the bill.
View BillPayment Properties
billId
String
bill.id
The internal ID of the bill associated with the payment.
billExternalId
String
bill.externalId
ID of the bill in the external system, if applicable.
billNumber
String
bill.tranId | bill.number
Bill number
id
String
id
The unique identifier for the payment transaction related to the bill.
transactionNumber
String
transactionNumber
Internal reference number for tracking the bill payment.
externalId
String
externalId
ID from an external system, if applicable.
paymentNumber
tranid
Payment Number
paymentDate
Datetime
tranDate
The date when the payment was made or recorded for the bill.
paymentStatus
String
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 bill, 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 if the payment is made in a different currency than the bill's currency, used to calculate the conversion.
accountId
String
account
The account associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
accountName
String
pick(accounts, "id", rec.account, "name")
The account name associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
vendorId
String
entity
The unique identifier of the vendor to whom the bill is owed.
vendorExternalId
String
pick(vendors, "id", rec.entity, "externalId")
The vendor’s ID in the external system, if applicable.
vendorNumber
String
pick(vendors, "id", rec.entity, "entityid")
A unique, typically human-readable code assigned to identify this vendor.
vendorName
String
pick(vendors, "id", rec.entity, "name")
The name of the vendor associated with the bill.
subsidiaryId
String
subsidiary
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
String
pick(subsidiary, "id", rec.subsidiary, "name")
Name of the subsidiary associated with the bill.
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this bill payment, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
hgTenantId
String
{tenantId}
Unique identifier for the HotGlue tenant associated with the bill.
subsidiaryId
String
subsidiary
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
String
pick(subsidiary, "id", rec.subsidiary, "name")
Name of the subsidiary associated with the bill.
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this bill, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
taxAmount
number
taxtotal
Sum of all taxes amount from item and expense lines
NetSuite
Example
{
"id": "23749",
"externalId": "BILL-EID-KO1",
"transactionNumber": "VENDBILL537",
"billNumber": "BILL-BNO-KO1",
"vendorId": "2425",
"vendorExternalId": "None",
"vendorNumber": "Golden Eagle Ventures",
"vendorName": "Golden Eagle Ventures",
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"status": "Bill : Open",
"dueDate": "2025-03-01T00:00:00.000000Z",
"balance": 90.0,
"totalAmount": -1090.0,
"issueDate": "2025-02-05T00:00:00.000000Z",
"customFields": [
{
"name": "custbody3",
"value": false
},
{
"name": "custbody_ste_use_tax",
"value": false
},
{
"name": "custbody_ste_rcs_applicable",
"value": false
}
],
"exchangeRate": 1.0,
"expenses": [
{
"id": "1",
"billId": "23749",
"description": "Monthly office rent",
"amount": 500.0,
"customFields": [],
"classId": "1",
"className": "Project 1",
"locationId": "1",
"locationName": "NOAM",
"departmentId": "5",
"departmentName": "Sales",
"dimensions": [
{
"name": "Class",
"valueId": "1",
"value": "Project 1"
},
{
"name": "Location",
"valueId": "1",
"value": "NOAM"
},
{
"name": "Department",
"valueId": "5",
"value": "Sales"
}
],
"subsidiaryId": "1",
"subsidiaryName": "Parent Company"
}
],
"description": "Bill Creation Test - Update via Bill Number & Vendor Number",
"relatedPayments": [
{
"id": "23849",
"billId": "23749",
"billExternalId": "BILL-EID-KO1",
"billNumber": "BILL-BNO-KO1",
"transactionNumber": "VENDPYMT68",
"paymentNumber": "55",
"paymentDate": "2025-02-01T00:00:00.000000Z",
"paymentStatus": "Bill Payment : Undefined",
"amount": 1000.0,
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"exchangeRate": 1.0,
"accountId": "1720",
"accountName": "Bank account #35",
"vendorId": "2425",
"vendorExternalId": "None",
"vendorNumber": "Golden Eagle Ventures",
"vendorName": "Golden Eagle Ventures",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"dimensions": [],
"hgTenantId": "default"
}
],
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"updatedAt": "2025-06-10T06:31:48.000000Z",
"createdAt": "2025-06-10T06:12:18.000000Z",
"hgTenantId": "default"
}BillPayment(BillPayments)
Parameters
billId
String
bill.id
The internal ID of the bill associated with the payment.
billExternalId
String
bill.externalId
ID of the bill in the external system, if applicable.
billNumber
String
bill.tranId | bill.number
Bill number
id
String
id
The unique identifier for the payment transaction related to the bill.
transactionNumber
String
transactionNumber
Internal reference number for tracking the bill payment.
externalId
String
externalId
ID from an external system, if applicable.
paymentNumber
tranid
Payment Number
paymentDate
Datetime
tranDate
The date when the payment was made or recorded for the bill.
paymentStatus
String
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 bill, 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 if the payment is made in a different currency than the bill's currency, used to calculate the conversion.
accountId
String
account
The account associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
accountName
String
pick(accounts, "id", rec.account, "name")
The account name associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
vendorId
String
entity
The unique identifier of the vendor to whom the bill is owed.
vendorExternalId
String
pick(vendors, "id", rec.entity, "externalId")
The vendor’s ID in the external system, if applicable.
vendorNumber
String
pick(vendors, "id", rec.entity, "entityid")
A unique, typically human-readable code assigned to identify this vendor.
vendorName
String
pick(vendors, "id", rec.entity, "name")
The name of the vendor associated with the bill.
subsidiaryId
String
subsidiary
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
String
pick(subsidiary, "id", rec.subsidiary, "name")
Name of the subsidiary associated with the bill.
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this bill payment, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
hgTenantId
String
{tenantId}
Unique identifier for the HotGlue tenant associated with the bill.
NetSuite
Example
{
"id": "23849",
"billId": "23749",
"billExternalId": "BILL-EID-KO1",
"billNumber": "BILL-BNO-KO1",
"transactionNumber": "VENDPYMT68",
"paymentNumber": "55",
"paymentDate": "2025-02-01T00:00:00.000000Z",
"paymentStatus": "Bill Payment : Undefined",
"amount": 1000.0,
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"exchangeRate": 1.0,
"accountId": "1720",
"accountName": "Bank account #35",
"vendorId": "2425",
"vendorExternalId": "None",
"vendorNumber": "Golden Eagle Ventures",
"vendorName": "Golden Eagle Ventures",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"dimensions": [],
"hgTenantId": "default"
}Class(Classes)
Parameters
id
String
id
Unique identifier for the class
externalId
String
externalId
Unique identifier for the location in an external system.
classExternalId
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.
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}
subsidiaryId
String
subsidiary.id
Unique ID of the subsidiary associated with the class
subsidiaryName
String
subsidiary.name
Name of the subsidiary associated with the class
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.
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",
"5"
],
"subsidiaryRef": [
{
"id": "2",
"name": "California"
},
{
"id": "5",
"name": "Germany"
},
{
"id": "4",
"name": "New York"
},
{
"id": "1",
"name": "Parent Company"
},
{
"id": "3",
"name": "Virginia"
}
],
"isActive": false,
"updatedAt": "2025-02-25T18:28:35.000000Z",
"hgTenantId": "default"
}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.
customerNumber
String
entityId
A unique, typically human-readable code assigned to identify this customer.
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.
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
String
"unknown" or "mobile" or "home"
Phone number type
phoneNumber
String
phone | mobilePhone | homePhone
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).
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.
categoryId
String
category
Unique identifier for the customer category.
categoryName
String
pick(customerCategories, "id", rec.category, "name")
Name of the customer category.
taxExemptionReasonId
String
The tax exemption reason associated with this customer object. Applicable if taxable is False
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
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": "13241",
"externalId": "TEST-CUST-KO-1",
"customerNumber": "TEST-CUST-KO-1",
"companyName": "TEST-CUST-KO-1",
"title": "car Assembler",
"email": "KIA@cars.com",
"website": "https://www.Kia.com",
"phoneNumbers": [
{
"type": "unknown",
"phoneNumber": "+18888665555"
},
{
"type": "mobile",
"phoneNumber": "+18888774445"
},
{
"type": "home",
"phoneNumber": "+14444665555"
}
],
"addresses": [
{
"id": "15243",
"addressType": "billing",
"addressText": "23 Jackson square NY - Billing",
"line1": "23 Jackson square NY",
"line2": "line2",
"city": "New York",
"state": "NY",
"postalCode": "19123",
"country": "US"
},
{
"id": "15242",
"addressType": "shipping",
"addressText": "2 Roosevelt Hotel NY - Shipping",
"line1": "2 Roosevelt Hotel NY",
"line2": "line2",
"city": "New York",
"state": "NY",
"postalCode": "19123",
"country": "US"
}
],
"parentId": "5133",
"parentName": "DAS Bootleg",
"categoryId": "1",
"categoryName": "Customer category 1",
"salesRepId": "2526",
"salesRepName": "Dean Nasseri",
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar",
"customFields": [
{
"name": "custentity1",
"value": "Hello"
}
],
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"isPerson": false,
"isActive": true,
"updatedAt": "2025-06-10T03:25:58.000000Z",
"createdAt": "2025-06-10T02:48:50.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.
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}
subsidiaryId
String
subsidiary.id
Unique ID of the subsidiary associated with the department
subsidiaryName
String
subsidiary.name
Name of the subsidiary associated with the department
isActive
Boolean
NOT isinactive
Indicates current status of the department, Active. Deleted, Unknown
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",
"5"
],
"subsidiaryRef": [
{
"id": "2",
"name": "California"
},
{
"id": "5",
"name": "Germany"
},
{
"id": "4",
"name": "New York"
},
{
"id": "1",
"name": "Parent Company"
},
{
"id": "3",
"name": "Virginia"
}
],
"isActive": true,
"updatedAt": "2025-02-25T18:25:52.000000Z",
"hgTenantId": "default"
}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.
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.
description
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
pick(subsidiaries, "id", rec.subsidiary, "currencyid")
Unique identifier for the currency used in the transaction.
currencyName
String
pick(currencies, "id", rec.currencyId, "name")
Name of the currency (e.g., US Dollar, Euro).
currency
String
pick(currencies, "id", rec.currencyId, "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.
classNumber
class Number
className
String
Classification.name
Name of the classification (used for reporting purposes).
postingDate
Datetime
CASE WHEN Transaction.TranDate BETWEEN AccountingPeriod.StartDate AND AccountingPeriod.EndDate THEN TO_CHAR (Transaction.TranDate, 'YYYY-MM-DD HH24:MI:SS') ELSE TO_CHAR (AccountingPeriod.StartDate , 'YYYY-MM-DD HH24:MI:SS') END
Date on which this transaction was posted to Journal.
periodId
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.
hgTenantId
String
{tenantId}
Unique identifier for the HotGlue tenant associated with the bill.
dimensions
Dimensions [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatments, "id", rec.department), pick(classes, "id", rec.class) ])
A collection of classfying attributes for this bill, such as department, class, location etc.
NetSuite
Example
{
"id": "170_1",
"accountName": "58 Expenses",
"fullyQualifiedAccountName": "58 Expenses",
"accountType": "Expense",
"accountNumber": "58",
"accountId": "58",
"entityName": "Leonard Building & Truck Acc.",
"entityId": "14",
"entityType": "Vendor",
"transactionType": "BILL",
"transactionDate": "2024-10-21T00:00:00.000000Z",
"transactionNumber": "VENDBILL94",
"tranDisplayName": "Bill #TEST70",
"description": "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",
"postingDate": "2024-10-21T00:00:00.000000Z",
"periodId": 15,
"periodName": "Oct 2024",
"periodStartDate": "2024-10-01T00:00:00.000000Z",
"periodEndDate": "2024-10-31T00:00:00.000000Z",
"dimensions": [
{
"name": "Class",
"valueId": "3",
"value": "Project 3"
},
{
"name": "Location",
"valueId": "6",
"value": "COLOMBIA"
},
{
"name": "Department",
"valueId": "3",
"value": "Information technology"
}
],
"hgTenantId": "default"
}Invoice(Invoices)
Parameters
String
id
Unique identifier for the invoice
String
transactionNumber
Internal reference number for tracking the invoice.
String
tranid | number
Invoice Number
String
externalId
ID from an external system, if applicable.
String
entity
The customer associated with the invoice.
String
pick(vendors, "id", rec.entity, "externalId")
Customer ID from an external system, if applicable.
String
pick(vendors, "id", rec.entity, "entityid")
A unique, typically human-readable code assigned to identify this customer.
String
pick(vendors, "id", rec.entity, "name")
Customer Name
String
memo
Additional details or notes about the customer invoice
String
pick(currencies, "id", rec.currency, "symbol")
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
String
currency
Unique identifier for the currency.
String
pick(currencies, "id", rec.currency, "name")
Full name of the currency (e.g., "US Dollar", "Euro").
Number
exchangerate
Exchange rate applied.
String
BUILTIN.DF(t.Status)
Current status of the invoice
Datetime
trandate
The date when the invoice was issued.
Datetime
duedate
The date by which the invoice is due.
Datetime
max(paymentDates) from invoicePayments
The date on which this invoice was marked as paid
Datetime
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).
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
Number
taxTotal
Total tax applied to this invoice
String
Tax code to be applied to the invoice
Number
foreigntotal - taxtotal
The total amount of the invoices before taxes.
Number
foreigntotal
The total amount of the invoice including tax.
Number
foreignamountunpaid
The outstanding balance remaining on the invoice.
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
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.
itemNumber
String
pick(items, "id", rec.item, "externalId")
Number of the product or service listed in the bill.
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.
description
String
memo
A text field providing additional information about the transaction line, such as specifications, notes, or special handling instructions.
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.
amount
Number
netamount
The total price for the transaction line, calculated by multiplying the unit price by the quantity, after applying any discounts and taxes.
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.
taxAmount
Number
taxamount * -1
Tax applied to the line
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this item, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
TaxLine [ ]
list(TaxLine, pick(taxlines, "transaction", rec.id)
Breakdown of taxes related to the bill.
View TaxLine Properties
id
String
id
Unique identifier for the customer within the system. Serves as the primary key.
taxCode
String
memo
Default tax code applied to the customer’s transactions.
taxAmount
Number
foreignamount * -1
Tax applied to the line
InvoicePayment [ ]
list(InvoicePayment, pick(invoicePayments, "transaction", rec.id))
Payment associated with this invoice
View InvoicePayment Properties
invoiceId
String
invoice.id (transaction)
The internal ID of the invoice associated with the payment.
invoiceExternalId
Sting
invoice.externalId
ID of the invoice in the external system, if applicable.
invoiceNumber
String
invoice.tranId | invoice.number
Invoice number
id
String
id
The unique identifier for the payment transaction related to the invoice.
transactionNumber
String
transactionNumber
Internal reference number for tracking the customer payment.
externalId
String
externalId
ID from an external system, if applicable.
paymentNumber
String
tranid
Payment Number
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
account
The account associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
accountName
String
pick(accounts, "id", rec.account, "name")
The account name associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
customerId
String
entity
The unique identifier of the customer to whom the bill is owed.
customerExternalId
String
pick(customers, "id", rec.entity, "externalId")
The customer's ID in the external system, if applicable.
customerNumber
String
pick(customers, "id", rec.entity, "entityid")
A unique, typically human-readable code assigned to identify this customer.
customerName
String
pick(customers, "id", rec.entity, "name")
The name of the customer associated with the bill.
subsidiaryId
String
subsidiary
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
String
pick(subsidiary, "id", rec.subsidiary, "name")
Name of the subsidiary associated with the bill.
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this bill payment, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
hgTenantId
{tenantId}
{tenantId}
Unique identifier for the HotGlue tenant associated with the bill.
String
subsidiary
The unique identifier for the subsidiary within a larger corporate structure associated with the transaction line.
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.'
Datetime
createddate
Timestamp when the invoice was created.
Datetime
lastmodifieddate
Timestamp when the invoice was last updated.
String
{tenantId}
Identifier for the HotGlue tenant associated with the invoice.
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this bill, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
NetSuite
Example
{
"id": "1349",
"transactionNumber": "CUSTINVC218",
"invoiceNumber": "218",
"customerId": "142",
"customerExternalId": "None",
"customerNumber": "36",
"customerName": "Cooks Heating & Cooling",
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"exchangeRate": 1.0,
"status": "Invoice : Open",
"issueDate": "2024-10-21T00:00:00.000000Z",
"dueDate": "2024-11-05T00:00:00.000000Z",
"shipDate": "2024-10-21T00:00:00.000000Z",
"postingDate": "2024-10-21T00:00:00.000000Z",
"addresses": [
{
"id": "152",
"addressType": "billing",
"addressText": "Cooks Heating & Cooling\nPo Box 190\nRural Hall NC 27045\nUnited States",
"line1": "Po Box 190",
"city": "Rural Hall",
"state": "NC",
"postalCode": "27045",
"country": "US"
},
{
"id": "152",
"addressType": "shipping",
"addressText": "Cooks Heating & Cooling\nPo Box 190\nRural Hall NC 27045\nUnited States",
"line1": "Po Box 190",
"city": "Rural Hall",
"state": "NC",
"postalCode": "27045",
"country": "US"
}
],
"taxAmount": 0.0,
"subtotal": 1510.0,
"totalAmount": 1510.0,
"balance": 1510.0,
"customFields": [],
"lineItems": [
{
"id": "1",
"invoiceId": "1349",
"itemId": "211",
"itemNumber": "None",
"itemName": "Product 7",
"description": "Product 7",
"quantity": 1.0,
"unitPrice": 1510.0,
"amount": 1510.0,
"customFields": [],
"classId": "1",
"className": "Project 1",
"locationId": "13",
"locationName": "SPAIN",
"departmentId": "5",
"departmentName": "Sales",
"dimensions": [
{
"name": "Class",
"valueId": "1",
"value": "Project 1"
},
{
"name": "Location",
"valueId": "13",
"value": "SPAIN"
},
{
"name": "Department",
"valueId": "5",
"value": "Sales"
}
]
}
],
"description": "TEST148",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"createdAt": "2024-10-21T15:32:44.000000Z",
"updatedAt": "2024-12-11T13:49:18.000000Z",
"hgTenantId": "default"
}InvoicePayment(InvoicePayments)
Parameters
invoiceId
String
invoice.id (transaction)
The internal ID of the invoice associated with the payment.
invoiceExternalId
Sting
invoice.externalId
ID of the invoice in the external system, if applicable.
invoiceNumber
String
invoice.tranId | invoice.number
Invoice number
id
String
id
The unique identifier for the payment transaction related to the invoice.
transactionNumber
String
transactionNumber
Internal reference number for tracking the customer payment.
externalId
String
externalId
ID from an external system, if applicable.
paymentNumber
String
tranid
Payment Number
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
account
The account associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
accountName
String
pick(accounts, "id", rec.account, "name")
The account name associated with the payment transaction, typically reflecting the bank, cash, or credit card account used to settle the payment (e.g., Checking Account, Petty Cash, Corporate Credit Card).
customerId
String
entity
The unique identifier of the customer to whom the bill is owed.
customerExternalId
String
pick(customers, "id", rec.entity, "externalId")
The customer's ID in the external system, if applicable.
customerNumber
String
pick(customers, "id", rec.entity, "entityid")
A unique, typically human-readable code assigned to identify this customer.
customerName
String
pick(customers, "id", rec.entity, "name")
The name of the customer associated with the bill.
subsidiaryId
String
subsidiary
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
String
pick(subsidiary, "id", rec.subsidiary, "name")
Name of the subsidiary associated with the bill.
dimensions
Dimension [ ]
list(Dimension, [ pick(locations, "id", rec.location), pick(depatment, "id", rec.department) ])
A collection of classfying attributes for this bill payment, such as department, class, location etc.
View Dimension Properties
name
String
"Class" or "Location" or "Department"
Name of the dimention type.
valueId
String
entity.classId | entity.locationId | entity.departmentId
Unique ID of dimension value in parent object.
value
String
entity.className | entity.locationName | entity.departmentName
dimension value in parent object.
hgTenantId
{tenantId}
{tenantId}
Unique identifier for the HotGlue tenant associated with the bill.
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.
itemNumber
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}.
subsidiaryId
String
subsidiary.id
Unique ID of the subsidiary associated with the item
subsidiaryName
String
subsidiary.name
Name of the subsidiary associated with the item
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.
hg_deleted
NetSuite
Example
{
"id": "1010",
"externalId": "None",
"itemNumber": "Office suppliers",
"name": "Product 10 : Office suppliers",
"code": "Office suppliers",
"displayName": "office_suppliers",
"type": "NonInvtPart",
"category": "Resale",
"isBillItem": true,
"itemVendors": [
{
"vendorId": "31",
"vendorName": "Advantage Controls, Llc",
"itemCost": 78.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar",
"isPreferredVendor": false
},
{
"vendorId": "21",
"vendorName": "ACR SUPPLY CO",
"itemCost": 78.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar",
"isPreferredVendor": false
},
{
"vendorId": "16",
"vendorName": "Accent Imaging Inc",
"itemCost": 78.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar",
"isPreferredVendor": false
}
],
"isInvoiceItem": true,
"itemVariants": [
{
"variantId": "1",
"variantName": "Base Price",
"minimumQuantity": 1.0,
"price": 25.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
},
{
"variantId": "1",
"variantName": "Base Price",
"minimumQuantity": 2.0,
"price": 23.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
},
{
"variantId": "1",
"variantName": "Base Price",
"minimumQuantity": 3.0,
"price": 21.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
},
{
"variantId": "1",
"variantName": "Base Price",
"minimumQuantity": 4.0,
"price": 20.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
},
{
"variantId": "2",
"variantName": "Alternate Price 1",
"minimumQuantity": 1.0,
"price": 27.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
},
{
"variantId": "2",
"variantName": "Alternate Price 1",
"minimumQuantity": 2.0,
"price": 25.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
},
{
"variantId": "2",
"variantName": "Alternate Price 1",
"minimumQuantity": 3.0,
"price": 23.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
},
{
"variantId": "2",
"variantName": "Alternate Price 1",
"minimumQuantity": 4.0,
"price": 21.0,
"currencyId": "1",
"currency": "USD",
"currencyName": "US Dollar"
}
],
"classId": "2",
"className": "Project 2",
"departmentId": "6",
"departmentName": "Accounting and finance",
"locationId": "3",
"locationName": "USA",
"accounts": [
{
"accountType": "expenseAccount",
"id": "58",
"accountNumber": "58",
"name": "58 Expenses"
},
{
"accountType": "incomeAccount",
"id": "54",
"name": "Sales"
}
],
"subsidiary": [
"1"
],
"subsidiaryRef": [
{
"id": "1",
"name": "Parent Company"
}
],
"isActive": true,
"updatedAt": "2025-02-27T13:04:16.000000Z",
"createdAt": "2025-02-21T14:21:26.000000Z",
"hgTenantId": "default"
}JournalEntry(JournalEntries)
Parameters
id
String
id
Unique identifier for the invoice
externalId
String
externalId
ID from an external system, if applicable.
journalEntryNumber
String
tranid
Entry Number
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.
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
The customer associated with the line item.
customerNumber
String
entity.entityId
Customer Number
customerName
String
pick(customers, "id", rec.location, "name")
Name of customer associated with the line item
vendorId
String
entity.id
The vendor associated with the line item.
vendorNumber
String
entity.entityId
Vendor Number
vendorName
String
pick(customers, "id", rec.location, "name")
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".
dimensions
Dimensions [ ]
A collection of classfying attributes for this bill, such as department, class, location etc.
subsidiaryId
subsidiary
Unique identifier of the subsidiary associated with the customer.
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.
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).
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
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}
subsidiaryId
String
subsidiary.id
Unique ID of the subsidiary associated with the location
subsidiaryName
String
subsidiary.name
Name of the subsidiary associated with the location
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": "17",
"name": "Location 2",
"fullname": "NOAM : USA : Location 2",
"parentId": "3",
"parentName": "USA",
"locationType": "3",
"locationTypeName": "USA",
"subsidiary": [
"2"
],
"subsidiaryRef": [
{
"id": "2",
"name": "California"
}
],
"isActive": true,
"updatedAt": "2025-03-07T09:06:02.000000Z",
"hgTenantId": "default"
}PurchaseOrder(PurchaseOrders)
Parameters
id
String
Unique identifier for the purchase order. Serves as the primary key for internal referencing.
transactionNumber
String
Internal reference number for tracking the purchase order.
purchaseOrderNumber
String
Purchase order number
externalId
String
Internal reference number for tracking the purchase order.
vendorId
String
Unique identifier of the vendor associated with the purchase order.
vendorExternalId
String
Number of the vendor associated with the bill.
vendorNumber
String
A unique, typically human-readable code assigned to identify this vendor.
vendorName
String
Name of the vendor associated with the purchase order.
description
String
Additional details or notes about the purchase order.
currency
String
The three-letter ISO code representing the currency (e.g., USD for US Dollar, EUR for Euro).
currencyId
String
Unique identifier for the currency.
currencyName
String
Full name of the currency (e.g., "US Dollar", "Euro").
exchangeRate
Number
Exchange rate applied.
status
String
Current status of the purchase order
dueDate
Datetime
Date the purchase order is due.
issueDate
Datetime
Timestamp indicating when the purchase order was created.
paidDate
Datetime
Date when the bill was paid.
lineItems
PurchaseOrderLineItem [ ]
List of individual items included in the purchase order.
View PurchaseOrderLineItem Properties
id
String
Unique identifier for the purchase order line item, auto-generated by the system.
purchaseOrderId
String
The reference ID of the parent purchase order to which this transaction line belongs.
itemId
String
Unique identifier of the product or service listed in the purchase order.
itemName
String
Name of the product or service listed in the bill.
itemNumber
String
Code of the product or service listed in the bill.
description
String
Additional details or notes about the item or service in this purchase order line.
quantity
Number
Number of units of the product or service in this purchase order.
unitPrice
Number
Price per unit of the product or service before applying discounts or taxes.
amount
Number
Total cost of this purchase order, calculated as (unitPrice × quantity) after any discounts or taxes.
customFields
CustomField [ ]
Additional metadata or custom attributes for this purchase order line item.
View CustomField Properties
name
id of the custom field attribute
value
Value of custom field
classId
String
Unique identifier for the classification of this transaction for reporting purposes.
className
String
Name of the classification
locationId
String
Unique identifier of the location associated with this purchase order line item.
locationName
String
Name of the location linked to this purchase order line item.
departmentId
String
Unique identifier of the department responsible for this purchase order line item.
departmentName
String
Name of the department
subsidiaryId
String
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
String
Name of the subsidiary associated with the bill.
employeeId
String
Unique identifier of the employee responsible for this purchase order line item.
employeeNumber
String
Number of the employee
employeeName
String
Name of the employee
projectId
String
Unique identifier of the project responsible for this purchase order line item.
projectExternalId
String
Project ID from an external system, if applicable.
projectNumber
String
Number of the project
projectName
String
Name of the project
dimensions
Dimension [ ]
A collection of classfying attributes for this item, such as department, class, location etc.
View Dimension Properties
name
String
Name of the dimention type.
valueId
String
Unique ID of dimension value in parent object.
value
String
dimension value in parent object.
subsidiaryId
String
Unique identifier of the subsidiary associated with the bill.
subsidiaryName
String
Name of the subsidiary associated with the bill.
customFields
CustomField [ ]
Additional metadata or custom attributes.
View CustomField Properties
name
id of the custom field attribute
value
Value of custom field
hgTenantId
String
Unique identifier for the HotGlue tenant associated with the bill.
createdAt
Datetime
Timestamp when the invoice was created.
updatedAt
Datetime
Timestamp when the invoice was last updated.
NetSuite
Example
{
"id": "23649",
"transactionNumber": "PURCHORD12",
"purchaseOrderNumber": "PO-Test-KO-1",
"externalId": "PO-EID-TEST-KO-1",
"vendorId": "2425",
"vendorExternalId": "None",
"vendorNumber": "Golden Eagle Ventures",
"vendorName": "Golden Eagle Ventures",
"description": "PO VC Description",
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"exchangeRate": 1.0,
"status": "Purchase Order : Pending Receipt",
"dueDate": "2025-06-07T00:00:00.000000Z",
"issueDate": "2025-05-29T00:00:00.000000Z",
"lineItems": [
{
"id": "1",
"purchaseOrderId": "23649",
"itemId": "5211",
"itemName": "ITEM-111",
"itemNumber": "ITEM-111",
"description": "Line Description 1",
"quantity": 11.0,
"unitPrice": 17.0,
"amount": 187.0,
"customFields": [],
"classId": "3",
"className": "Project 3",
"departmentId": "7",
"departmentName": "Production, research and development",
"employeeId": "8935",
"employeeName": "Vinicius Ghellere",
"projectId": "107",
"projectExternalId": "None",
"projectNumber": "1",
"projectName": "Central Carolina Ac Co",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"dimensions": [
{
"name": "Class",
"valueId": "3",
"value": "Project 3"
},
{
"name": "Department",
"valueId": "7",
"value": "Production, research and development"
}
]
}
],
"customFields": [
{
"name": "custbody3",
"value": false
},
{
"name": "custbody2",
"value": "125"
},
{
"name": "custbody_ste_use_tax",
"value": false
},
{
"name": "custbody_ste_rcs_applicable",
"value": false
}
],
"hgTenantId": "default",
"createdAt": "2025-06-09T14:40:24.000000Z",
"updatedAt": "2025-06-09T14:40:24.000000Z",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company"
}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).
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
lastModifiedDateTime
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",
"state": "NY",
"country": "US"
},
{
"id": "9237",
"addressType": "return",
"addressText": "119 W 23rd St, \r\nNew York, NY 10011\r\nNY \r\nUnited States",
"state": "NY",
"country": "US"
},
{
"id": "9236",
"addressType": "shipping",
"addressText": "244 5th Ave Suite 2212\r\nNew York, NY 10001\r\nNY \r\nUnited States",
"state": "NY",
"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-13T04:44:06.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).
periodId
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.
hgTenantId
String
Unique identifier for the HotGlue tenant associated with the bill.
NetSuite
Example
{
"accountId": "54",
"accountName": "Sales",
"fullyQualifiedAccountName": "Sales",
"accountType": "Income",
"periodId": 27,
"periodName": "Jun 2025",
"periodStartDate": "2025-06-01T00:00:00.000000Z",
"periodEndDate": "2025-06-30T00:00:00.000000Z",
"beginningBalance": -97.0,
"creditAmount": 0.0,
"debitAmount": 0.0,
"endingBalance": -97.0,
"currencyId": "1",
"currencyName": "US Dollar",
"currency": "USD",
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"hgTenantId": "default"
}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.
vendorNumber
String
entityId
A unique, typically human-readable code assigned to identify this vendor.
isPerson
Boolean
isPerson
True if this customer is an individual, and not a company.
vendorName
String
companyName
Official name of the vendor's company.
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.
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
String
"unknown" or "mobile" or "home"
Phone number type
phoneNumber
String
phone | mobilePhone | homePhone
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).
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": "13141",
"externalId": "TEST-KO-1",
"vendorNumber": "TEST-KO-1",
"vendorName": "Test vendor Name KO 1",
"fullName": "",
"email": "patek@watches.com",
"website": "http://www.patekphillip.com",
"phoneNumbers": [
{
"type": "unknown",
"phoneNumber": "+19051231234"
}
],
"addresses": [
{
"id": "15142",
"addressType": "billing",
"addressText": "Wrapbook\n8605 Santa Monica Blvd\nWest Hollywood CA 90069\nUnited States",
"line1": "8605 Santa Monica Blvd",
"city": "West Hollywood",
"state": "CA",
"postalCode": "90069",
"country": "US"
},
{
"id": "15143",
"addressType": "shipping",
"addressText": "Wrapbook\n8605 Santa Monica Blvd\nWest Hollywood CA 90069\nUnited States",
"line1": "8605 Santa Monica Blvd",
"city": "West Hollywood",
"state": "CA",
"postalCode": "90069",
"country": "US"
}
],
"balance": 0.0,
"balanceDate": "2025-07-08T20:59:57.007200Z",
"categoryId": "4",
"categoryName": "Supplies",
"currency": "USD",
"currencyId": "1",
"currencyName": "US Dollar",
"customFields": [],
"subsidiaryId": "1",
"subsidiaryName": "Parent Company",
"isPerson": false,
"isActive": true,
"updatedAt": "2025-06-09T16:21:31.000000Z",
"createdAt": "2025-06-09T16:21:29.000000Z",
"hgTenantId": "default"
}