| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId |
Sedona internal autonumber for the Customer record |
integer |
None. |
| CustomerNumber |
Customer Number the customer sees |
string |
String length: inclusive between 0 and 15 |
| CustomerName |
If a person, CustomerName should be passed in as "Last, First" |
string |
Required String length: inclusive between 0 and 60 |
| StatusCode |
Customer Status: AR = Active Recurring; ANR = Active Nonrecurring; CANC = Canceled; defaults to config setting for customerStatusCode if not supplied |
string |
String length: inclusive between 0 and 25 |
| TypeCode |
Value from AR_Type_Of_Customer table; list of valid options can be retrieved from GET: api/customertype |
string |
Required String length: inclusive between 0 and 25 |
| CollectionStatusCode |
Value from AR_Collection_Status table; defaults to config setting for customerCollectionStatusCode if not supplied |
string |
String length: inclusive between 0 and 25 |
| SalespersonCode |
Value from SY_Employee table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/salesperson |
string |
String length: inclusive between 0 and 25 |
| TermCode |
Value from AR_Term table (Payment terms); list of valid options can be retrieved from GET: api/term |
string |
Required String length: inclusive between 0 and 25 |
| TaxExemptNum |
Applies only to tax exempt organizations (i.e. government/nonprofit) |
string |
String length: inclusive between 0 and 20 |
| BlanketPO |
A Blanket PO is used as the default Purchase Order number for the Customer. |
string |
String length: inclusive between 0 and 20 |
| BlanketPOExpire |
date the blanket PO expires; defaults to null date (12/30/1899) if not needed |
string |
String length: inclusive between 0 and 25 |
| OldCustomerNumber |
Can store Customer Number from other systems |
string |
String length: inclusive between 0 and 15 |
| LastStatementDate |
read only; do not set explicitly; calculated automatically |
string |
String length: inclusive between 0 and 25 |
| NoLateFees |
Set to true for Customer to be by-passed for Late Fees and/or Finance Charges. |
boolean |
None. |
| NoStatements |
Set to true for Customer to be skipped when printing Statements. |
boolean |
None. |
| NoCollections |
Set to true for Customer to be disregarded for Collections. |
boolean |
None. |
| OkToIncreaseDate |
Date on which the Customer should be bypassed for all Company Rate Increases; defaults to 12/30/1899 if not needed |
string |
String length: inclusive between 0 and 25 |
| StatementBalance |
read only; do not set explicitly |
decimal number |
None. |
| PrintSiteOnInvoices |
Set to true to print Site information on Invoices and Statements |
boolean |
None. |
| PrintStatements |
Determines if you want to print Statements for this Customer. If false, this Customer will be skipped when printing Statements. |
boolean |
None. |
| PrintCycleInvoices |
Determines if Cycle Invoices should be printed for this Customer. If false, then Cycle (Recurring) Invoices will not be printed. |
boolean |
None. |
| RollUpRecurring |
Roll up all recurring items to one site. |
boolean |
None. |
| CustomerSince |
Generally the installation date of the first site; defaults to today if not supplied |
string |
String length: inclusive between 0 and 25 |
| BranchCode |
Value from AR_Branch table; defaults to config setting for branchCode if not supplied; list of valid options can be retrieved from GET: api/branch |
string |
String length: inclusive between 0 and 25 |
| CustomerGroupID |
Do not set explicitly; pass in GroupCode and this will be validated and set automatically |
integer |
None. |
| GroupCode |
Customer Group security feature; value from AR_Customer_Group table; list of valid options can be retrieved from GET: api/customergroup |
string |
String length: inclusive between 0 and 25 |
| Group2Code |
Secondary Customer Group; value from AR_Customer_Group table; list of valid options can be retrieved from GET: api/customergroup |
string |
String length: inclusive between 0 and 25 |
| CustomerName2 |
Secondary Customer Name |
string |
String length: inclusive between 0 and 60 |
| MasterAccountCode |
Master Account Number this customer should be under (if applicable); value from AR_Master_Account table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/masteraccount |
string |
String length: inclusive between 0 and 25 |
| CustomerRelationCode |
Value from AR_Customer_Relation table; for chain accounts (reporting purposes); defaults to N/A if not supplied |
string |
String length: inclusive between 0 and 25 |
| IsMaster |
Set to true if this account is a Master Account; will be added to AR_Master_Account table |
boolean |
None. |
| MasterAccountBilling |
If set to true, all sub account invoices are billed to Primary Master |
boolean |
None. |
| BalanceDue |
The amount currently owed by the customer. Returned only when getting a single customer. Not used with adds and updates. |
decimal number |
None. |
| TotalActiveRMR |
The total active RMR for the customer. Returned only when getting a single customer. Not used with adds and updates. |
decimal number |
None. |
| TotalActiveRAR |
The total active RAR for the customer. Returned only when getting a single customer. Not used with adds and updates. |
decimal number |
None. |
| FullNameAndNumber |
Customer Name - Customer Number |
string |
None. |
| CustomerBillPrimary | CustomerBill |
None. |