NEW API Management Portal

October 25,2021

Karmak has a new and improved APIM Portal with easier to use authentication and real time documentation to reduce errors.

All new APIs will be published within APIM.

If you are new to Unity and Karmak APIs, please head to portal.karmak.io to learn more.



This data object is used to return all customer information within the Customer program in the Fusion business system.

This information is found within the Accounts Receivable Customer program within the Fusion business system.

URL

/frw/Customer

Field Details…

Field Name Field Type Column Description
CustomerID int  
BillToAddressID int  
ShipToAddressID int  
CustomerBaseBranchID int  
BaseBranch varchar(10) This field displays the code associated with a customer base branch.
CustomerBaseBranchName varchar(100) This field displays the name of a customer base branch.
CustomerKey varchar(10) This field displays the key for a customer associated with AR detail.
CompanyName varchar(100) This field displays the company name of an A/P vendor.
ControlBranchID int  
ControlBranch varchar(10) This field displays the code associated with a control branch.
Inactive bit This field displays whether or not a given customer is set to inactive.
IsProspect bit This field displays whether or not a particular customer is a prospect customer.
IndustryTypeID int  
BusinessStructureID int  
BusinessStructure varchar(50) This field displays how a business on a customer account is structured.
BusinessTaxID varchar(20) This field displays the tax number associated with a business on a customer account.
CurrencyCodeID int  
CurrencyCode varchar(10) This field displays the currency code attached to a particular customer account.
MiscellaneousAccount bit This field displays whether or not a customer account is a miscellaneous account.
InternalAccount bit This field displays whether or not a customer account is an internal account.
WarrantyAccount bit This field displays whether or not a customer account is a warranty account.
InternalLRCustomer bit This field displays whether or not a customer account is for an internal lease/rental customer.
SubjectToFinanceCharge bit This field displays whether or not a customer is available to receive a finance charge.
PerformCreditCheck bit This field displays whether or not a customer is set to do a credit check procedure through the system.
Relationship varchar(6) This field displays the parent child relationship of a customer.  If the customer has a parent customer, we display child.  If the customer has children customers, we display Parent.
IsSeparateStatement int This field displays Y or N depending on whether a customer record is flagged for a separate statement.
InvoiceEmail varchar(100) This field displays the email address appearing on an invoice.
IsInvoiceEmailAllowed bit This field displays whether or not the customer account is allowed to have their invoices emailed.
StatementEmail varchar(100) This field displays the email address appearing on a statement.
IsStatementEmailAllowed bit This field displays whether or not the customer account is allowed to have their customer statements emailed.
AlertEmail varchar(100) This field displays the email address appearing on an alert.
IsAlertEmailAllowed bit This field displays whether or not the customer account is allowed to have alerts emailed.
PartsInvoiceEmail varchar(100) This field displays the email address to be used when parts invoices are billed to the given customer.
IsPartsInvoiceEmailAllowed bit This field displays whether the customer should be emailed when parts invoices are billed to them.
RepairOrderInvoiceEmail varchar(100) This field displays the email address to be used when repair invoices are billed to the given customer.
IsRepairOrderInvoiceEmailAllowed bit This field displays whether the customer should be emailed when repair invoices are billed to them.
SalesInvoiceEmail varchar(100) This field displays the email address to be used when unit sales invoices are billed to the given customer.
IsSalesInvoiceEmailAllowed bit This field displays whether the customer should be emailed when unit sales invoices are billed to them.
LeaseRentalInvoiceEmail varchar(100) This field displays the email address to be used when lease rental invoices are billed to the given customer.
IsLeaseRentalInvoiceEmailAllowed bit This field displays whether the customer should be emailed when lease rental invoices are billed to them.
FuelInvoiceEmail varchar(100) This field displays the email address to be used when fuel invoices are billed to the given customer.
IsFuelInvoiceEmailAllowed bit This field displays whether the customer should be emailed when fuel invoices are billed to them.
IsQuickCreate bit This field displays whether or not the customer was created via the Quick Create application.
LastInvoiceDate datetime This field displays the date on which an account was last invoiced.
LastPaymentDate datetime This field displays the last payment date for a note.
InvoicesYTD int This field displays the number of invoices for the current year to date.
InvoicesPYR int This field displays the number of invoices for the prior year.
HighOnAccountYTD decimal This field displays the current year’s high on account.
HighOnAccountPYR decimal This field displays the previous year’s high on account.
PaymentsYTD int This field displays the number of payments for a current year.
PaymentsPYR int This field displays the number of payments for the prior year.
AverageDaysToPayYTD int This field displays the customer’s average days to pay through current year to date.
AverageDaysToPayPYR int This field displays the customer’s prior year average days to pay.
StatementType varchar(20) This field displays the statement type associated with a given customer.
CustomerPartsServiceID int  
PartsServiceCustomerContactID int  
CustomerPartsServiceAccountStatusID int  
AccountStatus varchar(50) This field displays the status of a given customer account.
TaxCodeID int  
TaxStatus varchar(50) This field displays the tax status of the customer.
OutsidePartsSalesperson varchar(20) This field displays the outside parts salesperson attached to a customer account.
OutsideServiceSalesperson varchar(50)  
ServiceSalespersonID int  
ServiceSalesperson varchar(20) This field displays the service salesperson attached to a customer account.
ServiceSalespersonName varchar(201) This field displays the name of a corresponding service salesperson.
Territory varchar(50) This field displays the territory in which the given customer is located, with regards to outside salespeople.
AllowServiceUnitOwnership bit This field displays whether or not a customer is allowed to be assigned to an actual service unit.
IsLeaseRentalUnitRequired bit  
QLLaborAccountingID int  
LaborAccountingCode varchar(50) This field displays the labor accounting code for a given customer.
QLPartsAccountingID int  
PartsAccountingCode varchar(50) This field displays the parts accounting code for a given customer.
PaymentTermID int  
PaymentTerm varchar(50) This field displays the payment term attached to a given A/P invoice.
DefaultPaymentMethodID int  
DefaultPaymentMethod varchar(50) This field displays the default payment method assigned to a customer.
IsCustomerPORequired bit This field displays whether or not a customer is required to provide a purchase order number.
IsEHCExempt bit This field displays whether or not a customer is exempt from environmental handling charges.
PartsServiceCreditLimit decimal This field displays the credit limit for a customer on parts and service.
SeparateCoreInvoices bit This field displays whether or not a customer will get a separate Invoice for their core charges.
AlternateCoreCustomer varchar(10) If Separate Core Invoice is checked and this field is populated, the separate core invoice will be created for to the alternate core customer populated here.
SeparateCoreStatements bit This field displays whether or not a customer will get a separate AR statement for their core invoices.
SeparateCoreTerms varchar(50) This field displays the payment terms of the customer for the core invoices.
OutputSeparateCoreStatements bit If the customer is set  to get separate core statements, this setting determines if the separate core statement actually prints/emails.  (So, the customer may be set to have separate core statements, but this setting actually determines then if they produce).
IsLPORequired bit This field displays whether or not a LPO is required to be filled in before saving a Repair order or Parts order for the customer.
PickupDeliveryMethod varchar(100) This field displays the pickup delivery method for the customer that will default when a parts order is opened to them.
NoUsageUpdate bit This field displays whether or not parts parts sold to the customer will update the usage information for the part.  If this is set to yes and a part is added to an order, the action dropdown will display Sale - No Usage.  This is turned off by default for a customer record.
PrintPartLabelsForPartsInvoices bit This field displays whether or not parts labels should print when generating an invoice for the customer.
SurchargeExempt bit This field displays whether or not a customer is exempt from surcharges imposed for deliveries.
SurchargeZone varchar(50) This field displays the surcharge zone assigned to the customer.  Any value here overrides the surcharge zone defined at the branch level.
BlanketPONumber varchar(30) This field displays the blanket purchase order number provided by the customer.
IgnoreAccountingGroup bit This field displays whether or not accounting group accounting assigned to a part being sold to the customer will be ignored when invoicing occurs.
PrintExportLabels bit This field displays whether or not parts labels should print when generating an invoice for the customer.
SalesManagementAccountStatus varchar(50) This field displays the status of a customer within sales management.
SalesManagementTaxStatus varchar(50) This field displays the tax code attached to a customer within sales management.
SalesManagementUserName varchar(20) This field displays the Unit Inventory Salesperson associated with the customer.
SalesManagementSalesmanNumber varchar(20) This field displays the ID number for a salesman attached to a customer within sales management.
SalesManagementSalesman varchar(201) This field displays the salesman attached to a customer within sales management.
Established Date datetime This field displays the date on which a customer account was established.
SalesManagementCustomerCreditLimit decimal This field displays the credit limit for a customer within sales management.
CustAddUserID int  
CustAddUser varchar(20) This field displays the user name that added the record.
CustAddDate datetime This field displays the date on which a customer record was added.
CustUpdateUserID int  
CustUpdateUser varchar(20) This field displays the user who updated a customer record.
CustLastUpdate datetime This field displays when a customer record was last updated.
CustAddDateTimeZone decimal  
CustLastUpdateTimeZone decimal  
OutsidePartsSalespersonID int  
TotalBalanceDue decimal This field displays the total balance due for a given customer.
GrandTotalBalanceDue decimal  
LastPayment decimal This field displays the amount of last payment for a note.
IndustryType varchar(50) This field displays the industry type assigned to the customer record.
Amount Due Now decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 1-30 days past the net due date of the invoice.
Amount Due 30 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 31-60 days past the net due date of the invoice.
Amount Due 60 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 61-90 days past the net due date of the invoice.
Amount Due 90 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 91-120 days past the net due date of the invoice.
Amount Due Over 120 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are greater than or equal to 121 days past the net due date of the invoice.
Amount Not Due decimal Calculated total balance due for all invoices (excluding unapplied cash), where the net due date is less than or equal to today’s date.
Unapplied Cash decimal This field displays the total amount of unapplied cash on the customer’s account.
Total Balance Due decimal  
ParentCustomerNumber varchar(10) This field displays the customer number of the parent assigned to the customer.
ShopPhone varchar(30) This field displays the Shop Phone number of the customer.
OfficePhone varchar(30) This field displays the Office Phone number of the customer record.
CellPhone varchar(30) This field displays the Cell Phone number assigned to the customer record.
Fax varchar(30) This field displays the fax number assigned to customer record.
BillToAddress1 varchar(100) This field displays the Primary Bill-To address line 1 of the customer record.
BillToAddress2 varchar(100) This field displays the Primary Bill-To Address line 2 of the customer record.
BillToCity varchar(100) This field displays the Primary Bill-To City of the customer record.
BillToRegion varchar(6) This field displays the Primary Bill-To Region of the customer record.
BillToTaxBody varchar(50) This field displays the Primary Bill-To Tax body of the customer record.
BillToPostalCode varchar(15) This field displays the Primary Bill-To Postal Code of the customer record.
ShipToAddress1 varchar(100) This field displays the Primary Ship-To Address line 1 of the customer.
ShipToAddress2 varchar(100) This field displays the Primary Ship-To Address line 2 of the customer.
ShipToCity varchar(100) This field displays the Primary Ship-To City of the customer.
ShipToRegion varchar(6) This field displays the Primary Ship-To Region of the customer.
ShipToTaxBody varchar(50) This field displays the Primary Ship-To Tax body of the customer.
ShipToPostalCode varchar(15) This field displays the Primary Ship-To Postal code of the customer.
CustomerPriceType varchar(50) This field dislays the Customer Price type assigned to the customer recod.
EntityTypeID int  
BillToAddressTypeID int  
ShipToAddressTypeID int  
SubjectToDelinquency bit This field displays if the customer is subject to delinquency.  If this is set to yes, when the delinquency job runs this customer will be included. If it is set to no, then this customer will not be included.
OverrideDelinquencyTerms int This field displays the override delinquency term in days for the customer record.  This value overrides the default value defined in Delinquency setup application.
AllowFuelTicket bit This field displays whether or not fuel tickets can be created for the customer.
FuelOverridePaymentTerms varchar(50) This field displays the payment terms for fuel invoices for the customer.  If no payment term is present, then the customers default payment terms will be applied to any fuel invoice.
SeparateInvoicePetFuelTicket bit This field displays whether or not a customer will receive one invoice for every fuel ticket or if all of their fuel tickets will be lumped into one fuel invoice.
NationaLeaseAccountNumber varchar(30) This field displays the customer’s NationaLease Account number.
LeaseContractSalesperson varchar(20) This field displays the salesperson assigned to the customer for lease contracts.
RentalContractSalesperson varchar(20) This field displays the salesperson assigned to the customer for rental contracts.
MaintenanceContractSalesperson varchar(20) This field displays the salesperson assigned to the customer for maintenance contracts.
DOT varchar(100) This field displays the customer’s Department of Transportation ID number.
CVOR varchar(100) This field displays the customer’s Commerical Vehicle Operators Registration number.
CommentTablesID int  
CanadianTaxID varchar(15) This field displays the Canadian tax ID listed on the customer form.
QuebecTaxID varchar(16) This field displays the Quebec tax ID listed on the customer form.
InvoiceDateAmountNotDue decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice date is greater than today’s date.
InvoiceDateAmountDueNow decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 1-30 days after the invoice date.
InvoiceDateAmountDue30 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 31-60 days after the invoice date.
InvoiceDateAmountDue60 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 61-90 days after the invoice date.
InvoiceDateAmountDue90 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are between 91-120 days after the invoice date.
InvoiceDateAmountDueOver120 decimal Calculated total balance due for all invoices (excluding unapplied cash), where the invoice’s are greater than or equal to 121 days after the invoice date.
OverridePastDueDays int  
IsPastDue bit  
IsSubjectToPastDue bit  
PastDueAmount decimal  
TotalCreditReserve decimal  
CoreRightToReturnDays int  
AutomatedContractPricing varchar(10)