interface QuickBooksNodeParameters {
additionalFields?:
| {
APAccountRef?: {
details: { name?: string; value?: string };
};
Balance?: string;
DueDate?: string;
SalesTermRef?: {
details: { name?: string; value?: string };
};
TotalAmt?: number;
TxnDate?: string;
}
| {
Active?: boolean;
Balance?: string;
BalanceWithJobs?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillWithParent?: boolean;
CompanyName?: string;
FamilyName?: string;
FullyQualifiedName?: string;
GivenName?: string;
PreferredDeliveryMethod?: "None"
| "Print"
| "Email";
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Taxable?: boolean;
}
| {
Active?: boolean;
BillableTime?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
DisplayName?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
SSN?: string;
}
| {
ApplyTaxAfterDiscount?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
TotalAmt?: number;
TotalTax?: number;
TxnDate?: string;
}
| {
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
DueDate?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: string;
TotalAmt?: number;
TxnDate?: string;
}
| { TxnDate?: string }
| {
AcctNum?: string;
Active?: boolean;
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
CompanyName?: string;
FamilyName?: string;
GivenName?: string;
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Vendor1099?: boolean;
};
billId?: string;
binaryProperty?: string;
customerId?: string;
CustomerRef?: string;
displayName?: string;
download?: boolean;
email?: string;
employeeId?: string;
estimateId?: string;
FamilyName?: string;
fileName?: string;
filters?: | { query?: string }
| {
appaid?: "All" | "Paid" | "Unpaid";
arpaid?: "All" | "Paid" | "Unpaid";
bothamount?: number;
cleared?:
| "Cleared"
| "Uncleared"
| "Reconciled"
| "Deposited";
columns?: (
| "name"
| "account_name"
| "create_by"
| "create_date"
| "cust_msg"
| "dept_name"
| "due_date"
| "doc_num"
| "inv_date"
| "is_ap_paid"
| "is_cleared"
| "last_mod_by"
| "memo"
| "other_account"
| "pmt_mthod"
| "is_no_post"
| "printed"
| "sales_cust1"
| "sales_cust2"
| "sales_cust3"
| "term_name"
| "tracking_num"
| "tx_date"
| "txn_type"
)[];
createdate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
customer?: unknown[];
date_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
dateRangeCreationCustom?: {
dateRangeCreationCustomProperties: {
end_createdate?: string;
start_createdate?: string;
};
};
dateRangeCustom?: {
dateRangeCustomProperties: {
end_date?: string;
start_date?: string;
};
};
dateRangeDueCustom?: {
dateRangeDueCustomProperties: {
end_duedate?: string;
start_duedate?: string;
};
};
dateRangeModificationCustom?: {
dateRangeModificationCustomProperties: {
end_moddate?: string;
start_moddate?: string;
};
};
department?: unknown[];
docnum?: string;
duedate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
group_by?: | "None"
| "Customer"
| "Account"
| "Day"
| "Employee"
| "Location"
| "Month"
| "Name"
| "Payment Method"
| "Quarter"
| "Transaction Type"
| "Vendor"
| "Week"
| "Year";
memo?: unknown[];
moddate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
payment_Method?: | "American Express"
| "Cash"
| "Check"
| "Dinners Club"
| "Discover"
| "Master Card"
| "Visa";
printed?: "Printed"
| "To_be_printed";
qzurl?: boolean;
sort_by?:
| "name"
| "account_name"
| "create_by"
| "create_date"
| "cust_msg"
| "dept_name"
| "due_date"
| "doc_num"
| "inv_date"
| "is_ap_paid"
| "is_cleared"
| "last_mod_by"
| "memo"
| "other_account"
| "pmt_mthod"
| "is_no_post"
| "printed"
| "sales_cust1"
| "sales_cust2"
| "sales_cust3"
| "term_name"
| "tracking_num"
| "tx_date"
| "txn_type";
sort_order?: "Ascend"
| "Descend";
source_account_type?:
| "AccountsPayable"
| "AccountsReceivable"
| "Bank"
| "CostOfGoodsSold"
| "CreditCard"
| "Equity"
| "Expense"
| "FixedAsset"
| "Income"
| "LongTermLiability"
| "NonPosting"
| "OtherAsset"
| "OtherCurrentAsset"
| "OtherCurrentLiability"
| "OtherExpense"
| "OtherIncome";
term?: unknown[];
transaction_type?: | "Check"
| "Bill"
| "BillPaymentCheck"
| "BillPaymentCreditCard"
| "BillableCharge"
| "CashPurchase"
| "Charge"
| "Credit"
| "CreditCardCharge"
| "CreditCardCredit"
| "CreditMemo"
| "CreditRefund"
| "Deposit"
| "Estimate"
| "GlobalTaxAdjustment"
| "GlobalTaxPayment"
| "InventoryQuantityAdjustment"
| "Invoice"
| "JournalEntry"
| "PurchaseOrder"
| "ReceivePayment"
| "SalesReceipt"
| "Service Tax Defer"
| "Service Tax Gross Adjustment"
| "Service Tax Partial Utilisation"
| "Service Tax Refund"
| "Service Tax Reversal"
| "Statement"
| "TimeActivity"
| "Transfer"
| "VendorCredit";
vendor?: unknown[];
};
GivenName?: string;
invoiceId?: string;
itemId?: string;
limit?: number;
Line?: | {
accountId?: string;
Amount?: number;
Description?: string;
DetailType?: | "AccountBasedExpenseLineDetail"
| "ItemBasedExpenseLineDetail";
itemId?: string;
LineNum?: number;
}
| {
Amount?: number;
Description?: string;
DetailType?: "SalesItemLineDetail";
itemId?: string;
LineNum?: number;
TaxCodeRef?: string;
}
| {
Amount?: number;
Description?: string;
DetailType?: "SalesItemLineDetail";
itemId?: string;
LineNum?: number;
Qty?: number;
TaxCodeRef?: string;
};
operation?: | "create"
| "get"
| "getAll"
| "update"
| "delete"
| "send"
| "void"
| "getReport";
paymentId?: string;
purchaseId?: string;
resource?: | "item"
| "employee"
| "customer"
| "invoice"
| "estimate"
| "payment"
| "transaction"
| "bill"
| "purchase"
| "vendor";
returnAll?: boolean;
simple?: boolean;
TotalAmt?: number;
updateFields?: | {
APAccountRef?: {
details: { name?: string; value?: string };
};
DueDate?: string;
SalesTermRef?: {
details: { name?: string; value?: string };
};
TxnDate?: string;
}
| {
Active?: boolean;
Balance?: string;
BalanceWithJobs?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillWithParent?: boolean;
CompanyName?: string;
FamilyName?: string;
FullyQualifiedName?: string;
GivenName?: string;
PreferredDeliveryMethod?: "None"
| "Print"
| "Email";
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Taxable?: boolean;
}
| {
Active?: boolean;
BillableTime?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
DisplayName?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
SSN?: string;
}
| {
ApplyTaxAfterDiscount?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
TxnDate?: string;
}
| {
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
DueDate?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: string;
TxnDate?: string;
}
| { TxnDate?: string }
| {
AcctNum?: string;
Active?: boolean;
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
CompanyName?: string;
FamilyName?: string;
GivenName?: string;
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Vendor1099?: boolean;
};
vendorId?: string;
VendorRef?: string;
}
Properties§
Source§readonly additional Fields?:
| {
APAccountRef?: {
details: { name?: string; value?: string };
};
Balance?: string;
DueDate?: string;
SalesTermRef?: {
details: { name?: string; value?: string };
};
TotalAmt?: number;
TxnDate?: string;
}
| {
Active?: boolean;
Balance?: string;
BalanceWithJobs?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillWithParent?: boolean;
CompanyName?: string;
FamilyName?: string;
FullyQualifiedName?: string;
GivenName?: string;
PreferredDeliveryMethod?: "None"
| "Print"
| "Email";
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Taxable?: boolean;
}
| {
Active?: boolean;
BillableTime?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
DisplayName?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
SSN?: string;
}
| {
ApplyTaxAfterDiscount?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
TotalAmt?: number;
TotalTax?: number;
TxnDate?: string;
}
| {
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
DueDate?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: string;
TotalAmt?: number;
TxnDate?: string;
}
| { TxnDate?: string }
| {
AcctNum?: string;
Active?: boolean;
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
CompanyName?: string;
FamilyName?: string;
GivenName?: string;
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Vendor1099?: boolean;
}
readonly additional Fields?:
| {
APAccountRef?: {
details: { name?: string; value?: string };
};
Balance?: string;
DueDate?: string;
SalesTermRef?: {
details: { name?: string; value?: string };
};
TotalAmt?: number;
TxnDate?: string;
}
| {
Active?: boolean;
Balance?: string;
BalanceWithJobs?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillWithParent?: boolean;
CompanyName?: string;
FamilyName?: string;
FullyQualifiedName?: string;
GivenName?: string;
PreferredDeliveryMethod?: "None"
| "Print"
| "Email";
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Taxable?: boolean;
}
| {
Active?: boolean;
BillableTime?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
DisplayName?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
SSN?: string;
}
| {
ApplyTaxAfterDiscount?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
TotalAmt?: number;
TotalTax?: number;
TxnDate?: string;
}
| {
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
DueDate?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: string;
TotalAmt?: number;
TxnDate?: string;
}
| { TxnDate?: string }
| {
AcctNum?: string;
Active?: boolean;
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
CompanyName?: string;
FamilyName?: string;
GivenName?: string;
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Vendor1099?: boolean;
}
Source§readonly Customer Ref?: string
readonly Customer Ref?: string
The ID of the customer who the estimate is for. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getCustomers"}
Source§readonly filters?:
| { query?: string }
| {
appaid?: "All" | "Paid" | "Unpaid";
arpaid?: "All" | "Paid" | "Unpaid";
bothamount?: number;
cleared?:
| "Cleared"
| "Uncleared"
| "Reconciled"
| "Deposited";
columns?: (
| "name"
| "account_name"
| "create_by"
| "create_date"
| "cust_msg"
| "dept_name"
| "due_date"
| "doc_num"
| "inv_date"
| "is_ap_paid"
| "is_cleared"
| "last_mod_by"
| "memo"
| "other_account"
| "pmt_mthod"
| "is_no_post"
| "printed"
| "sales_cust1"
| "sales_cust2"
| "sales_cust3"
| "term_name"
| "tracking_num"
| "tx_date"
| "txn_type"
)[];
createdate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
customer?: unknown[];
date_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
dateRangeCreationCustom?: {
dateRangeCreationCustomProperties: {
end_createdate?: string;
start_createdate?: string;
};
};
dateRangeCustom?: {
dateRangeCustomProperties: {
end_date?: string;
start_date?: string;
};
};
dateRangeDueCustom?: {
dateRangeDueCustomProperties: {
end_duedate?: string;
start_duedate?: string;
};
};
dateRangeModificationCustom?: {
dateRangeModificationCustomProperties: {
end_moddate?: string;
start_moddate?: string;
};
};
department?: unknown[];
docnum?: string;
duedate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
group_by?: | "None"
| "Customer"
| "Account"
| "Day"
| "Employee"
| "Location"
| "Month"
| "Name"
| "Payment Method"
| "Quarter"
| "Transaction Type"
| "Vendor"
| "Week"
| "Year";
memo?: unknown[];
moddate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
payment_Method?: | "American Express"
| "Cash"
| "Check"
| "Dinners Club"
| "Discover"
| "Master Card"
| "Visa";
printed?: "Printed"
| "To_be_printed";
qzurl?: boolean;
sort_by?:
| "name"
| "account_name"
| "create_by"
| "create_date"
| "cust_msg"
| "dept_name"
| "due_date"
| "doc_num"
| "inv_date"
| "is_ap_paid"
| "is_cleared"
| "last_mod_by"
| "memo"
| "other_account"
| "pmt_mthod"
| "is_no_post"
| "printed"
| "sales_cust1"
| "sales_cust2"
| "sales_cust3"
| "term_name"
| "tracking_num"
| "tx_date"
| "txn_type";
sort_order?: "Ascend"
| "Descend";
source_account_type?:
| "AccountsPayable"
| "AccountsReceivable"
| "Bank"
| "CostOfGoodsSold"
| "CreditCard"
| "Equity"
| "Expense"
| "FixedAsset"
| "Income"
| "LongTermLiability"
| "NonPosting"
| "OtherAsset"
| "OtherCurrentAsset"
| "OtherCurrentLiability"
| "OtherExpense"
| "OtherIncome";
term?: unknown[];
transaction_type?: | "Check"
| "Bill"
| "BillPaymentCheck"
| "BillPaymentCreditCard"
| "BillableCharge"
| "CashPurchase"
| "Charge"
| "Credit"
| "CreditCardCharge"
| "CreditCardCredit"
| "CreditMemo"
| "CreditRefund"
| "Deposit"
| "Estimate"
| "GlobalTaxAdjustment"
| "GlobalTaxPayment"
| "InventoryQuantityAdjustment"
| "Invoice"
| "JournalEntry"
| "PurchaseOrder"
| "ReceivePayment"
| "SalesReceipt"
| "Service Tax Defer"
| "Service Tax Gross Adjustment"
| "Service Tax Partial Utilisation"
| "Service Tax Refund"
| "Service Tax Reversal"
| "Statement"
| "TimeActivity"
| "Transfer"
| "VendorCredit";
vendor?: unknown[];
}
readonly filters?:
| { query?: string }
| {
appaid?: "All" | "Paid" | "Unpaid";
arpaid?: "All" | "Paid" | "Unpaid";
bothamount?: number;
cleared?:
| "Cleared"
| "Uncleared"
| "Reconciled"
| "Deposited";
columns?: (
| "name"
| "account_name"
| "create_by"
| "create_date"
| "cust_msg"
| "dept_name"
| "due_date"
| "doc_num"
| "inv_date"
| "is_ap_paid"
| "is_cleared"
| "last_mod_by"
| "memo"
| "other_account"
| "pmt_mthod"
| "is_no_post"
| "printed"
| "sales_cust1"
| "sales_cust2"
| "sales_cust3"
| "term_name"
| "tracking_num"
| "tx_date"
| "txn_type"
)[];
createdate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
customer?: unknown[];
date_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
dateRangeCreationCustom?: {
dateRangeCreationCustomProperties: {
end_createdate?: string;
start_createdate?: string;
};
};
dateRangeCustom?: {
dateRangeCustomProperties: {
end_date?: string;
start_date?: string;
};
};
dateRangeDueCustom?: {
dateRangeDueCustomProperties: {
end_duedate?: string;
start_duedate?: string;
};
};
dateRangeModificationCustom?: {
dateRangeModificationCustomProperties: {
end_moddate?: string;
start_moddate?: string;
};
};
department?: unknown[];
docnum?: string;
duedate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
group_by?: | "None"
| "Customer"
| "Account"
| "Day"
| "Employee"
| "Location"
| "Month"
| "Name"
| "Payment Method"
| "Quarter"
| "Transaction Type"
| "Vendor"
| "Week"
| "Year";
memo?: unknown[];
moddate_macro?: | "Today"
| "Yesterday"
| "This Week"
| "Last Week"
| "This Week-to-Date"
| "Last Week-to-Date"
| "Next Week"
| "Next 4 Weeks"
| "This Month"
| "Last Month"
| "This Month-to-Date"
| "Last Month-to-Date"
| "Next Month"
| "This Fiscal Quarter"
| "Last Fiscal Quarter"
| "This Fiscal Quarter-to-Date"
| "Last Fiscal Quarter-to-Date"
| "Next Fiscal Quarter"
| "This Fiscal Year"
| "Last Fiscal Year"
| "This Fiscal Year-to-Date"
| "Last Fiscal Year-to-Date"
| "Next Fiscal Year";
payment_Method?: | "American Express"
| "Cash"
| "Check"
| "Dinners Club"
| "Discover"
| "Master Card"
| "Visa";
printed?: "Printed"
| "To_be_printed";
qzurl?: boolean;
sort_by?:
| "name"
| "account_name"
| "create_by"
| "create_date"
| "cust_msg"
| "dept_name"
| "due_date"
| "doc_num"
| "inv_date"
| "is_ap_paid"
| "is_cleared"
| "last_mod_by"
| "memo"
| "other_account"
| "pmt_mthod"
| "is_no_post"
| "printed"
| "sales_cust1"
| "sales_cust2"
| "sales_cust3"
| "term_name"
| "tracking_num"
| "tx_date"
| "txn_type";
sort_order?: "Ascend"
| "Descend";
source_account_type?:
| "AccountsPayable"
| "AccountsReceivable"
| "Bank"
| "CostOfGoodsSold"
| "CreditCard"
| "Equity"
| "Expense"
| "FixedAsset"
| "Income"
| "LongTermLiability"
| "NonPosting"
| "OtherAsset"
| "OtherCurrentAsset"
| "OtherCurrentLiability"
| "OtherExpense"
| "OtherIncome";
term?: unknown[];
transaction_type?: | "Check"
| "Bill"
| "BillPaymentCheck"
| "BillPaymentCreditCard"
| "BillableCharge"
| "CashPurchase"
| "Charge"
| "Credit"
| "CreditCardCharge"
| "CreditCardCredit"
| "CreditMemo"
| "CreditRefund"
| "Deposit"
| "Estimate"
| "GlobalTaxAdjustment"
| "GlobalTaxPayment"
| "InventoryQuantityAdjustment"
| "Invoice"
| "JournalEntry"
| "PurchaseOrder"
| "ReceivePayment"
| "SalesReceipt"
| "Service Tax Defer"
| "Service Tax Gross Adjustment"
| "Service Tax Partial Utilisation"
| "Service Tax Refund"
| "Service Tax Reversal"
| "Statement"
| "TimeActivity"
| "Transfer"
| "VendorCredit";
vendor?: unknown[];
}
Default: {}
Source§readonly limit?: number
readonly limit?: number
Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":1000}
Source§readonly Line?:
| {
accountId?: string;
Amount?: number;
Description?: string;
DetailType?: | "AccountBasedExpenseLineDetail"
| "ItemBasedExpenseLineDetail";
itemId?: string;
LineNum?: number;
}
| {
Amount?: number;
Description?: string;
DetailType?: "SalesItemLineDetail";
itemId?: string;
LineNum?: number;
TaxCodeRef?: string;
}
| {
Amount?: number;
Description?: string;
DetailType?: "SalesItemLineDetail";
itemId?: string;
LineNum?: number;
Qty?: number;
TaxCodeRef?: string;
}
readonly Line?:
| {
accountId?: string;
Amount?: number;
Description?: string;
DetailType?: | "AccountBasedExpenseLineDetail"
| "ItemBasedExpenseLineDetail";
itemId?: string;
LineNum?: number;
}
| {
Amount?: number;
Description?: string;
DetailType?: "SalesItemLineDetail";
itemId?: string;
LineNum?: number;
TaxCodeRef?: string;
}
| {
Amount?: number;
Description?: string;
DetailType?: "SalesItemLineDetail";
itemId?: string;
LineNum?: number;
Qty?: number;
TaxCodeRef?: string;
}
Individual line item of a transaction Default: {} Type options: {"multipleValues":true}
Source§readonly operation?:
| "create"
| "get"
| "getAll"
| "update"
| "delete"
| "send"
| "void"
| "getReport"
readonly operation?:
| "create"
| "get"
| "getAll"
| "update"
| "delete"
| "send"
| "void"
| "getReport"
Default: "get"
Source§readonly resource?:
| "item"
| "employee"
| "customer"
| "invoice"
| "estimate"
| "payment"
| "transaction"
| "bill"
| "purchase"
| "vendor"
readonly resource?:
| "item"
| "employee"
| "customer"
| "invoice"
| "estimate"
| "payment"
| "transaction"
| "bill"
| "purchase"
| "vendor"
Default: "customer"
Source§readonly simple?: boolean
readonly simple?: boolean
Whether to return a simplified version of the response instead of the raw data Default: true
Source§readonly update Fields?:
| {
APAccountRef?: {
details: { name?: string; value?: string };
};
DueDate?: string;
SalesTermRef?: {
details: { name?: string; value?: string };
};
TxnDate?: string;
}
| {
Active?: boolean;
Balance?: string;
BalanceWithJobs?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillWithParent?: boolean;
CompanyName?: string;
FamilyName?: string;
FullyQualifiedName?: string;
GivenName?: string;
PreferredDeliveryMethod?: "None"
| "Print"
| "Email";
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Taxable?: boolean;
}
| {
Active?: boolean;
BillableTime?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
DisplayName?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
SSN?: string;
}
| {
ApplyTaxAfterDiscount?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
TxnDate?: string;
}
| {
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
DueDate?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: string;
TxnDate?: string;
}
| { TxnDate?: string }
| {
AcctNum?: string;
Active?: boolean;
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
CompanyName?: string;
FamilyName?: string;
GivenName?: string;
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Vendor1099?: boolean;
}
readonly update Fields?:
| {
APAccountRef?: {
details: { name?: string; value?: string };
};
DueDate?: string;
SalesTermRef?: {
details: { name?: string; value?: string };
};
TxnDate?: string;
}
| {
Active?: boolean;
Balance?: string;
BalanceWithJobs?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillWithParent?: boolean;
CompanyName?: string;
FamilyName?: string;
FullyQualifiedName?: string;
GivenName?: string;
PreferredDeliveryMethod?: "None"
| "Print"
| "Email";
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Taxable?: boolean;
}
| {
Active?: boolean;
BillableTime?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
DisplayName?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
SSN?: string;
}
| {
ApplyTaxAfterDiscount?: boolean;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
TxnDate?: string;
}
| {
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
BillEmail?: string;
CustomerMemo?: string;
CustomFields?: {
Field: {
DefinitionId?: string;
StringValue?: string;
}[];
};
DocNumber?: string;
DueDate?: string;
EmailStatus?: "NotSet"
| "NeedToSend"
| "EmailSent";
PrintStatus?:
| "NotSet"
| "NeedToPrint"
| "PrintComplete";
ShipAddr?: string;
TxnDate?: string;
}
| { TxnDate?: string }
| {
AcctNum?: string;
Active?: boolean;
Balance?: number;
BillAddr?: {
details: {
City?: string;
CountrySubDivisionCode?: string;
Lat?: string;
Line1?: string;
Long?: string;
PostalCode?: string;
};
};
CompanyName?: string;
FamilyName?: string;
GivenName?: string;
PrimaryEmailAddr?: string;
PrimaryPhone?: string;
PrintOnCheckName?: string;
Vendor1099?: boolean;
}
Default: {}
Source§readonly Vendor Ref?: string
readonly Vendor Ref?: string
The ID of the vendor who the bill is for. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getVendors"}
Default: {}