Customer - accountsIQ/API-Wiki GitHub Wiki

Represent a customer account in the accountsIQ system.

Customer

Customer members

Name Type Description Constraints
AccountReferralID String Get/Set the supplier's referral identifier.
  • Cannot be longer than 50 characters long.
Address1 String Get/Set the customer's first line of address.
  • Cannot be longer than 50 characters long.
Address2 String Get/Set the customer's second line of address.
  • Cannot be longer than 50 characters long.
AreaID String Get/Set the customer's area identifier.
  • Cannot be NULL.
  • Cannot be empty.
  • Cannot be longer than 50 characters long.
AuthorUserID String Get the identifier of the user who created the stock item.
    BankAccountCode String Get/Set the customer's bank account code. The list of bank accounts can be obtained by calling the GetBankList method.
    • Cannot be NULL.
    • Cannot be empty.
    • Cannot be longer than 50 characters long.
    BankSortCode String Get/Set the customer's bank sort code.
    • Cannot be longer than 50 characters long.
    BankSwiftCode String Get/Set the customer's bank swift code.
    • Cannot be longer than 50 characters long.
    City String Get/Set the customer's city name.
    • Cannot be longer than 50 characters long.
    Code String Get the unique customer code in the system.
    • Cannot be null or empty.
    • Cannot be longer than 50 characters long.
    • Must be upper case.
    Contact String Get/Set the customer's contact name.
    • Cannot be longer than 50 characters long.
    ControlGLAccountCode String Get/Set the customer's control general ledger account code. The GL account codes can be obtained by calling the GetGLAccountList method. A pre-set value can also be used when creating a new customer using the GetNewCustomerFromDefaults method.
      ControlGLAccountCode String Get/Set the customer's control general ledger account code. The GL account codes can be obtained by calling the GetGLAccountList method. A pre-set value can also be used when creating a new customer using the GetNewCustomerFromDefaults method.
      • Cannot be NULL.
      • Cannot be empty.
      • Cannot be longer than 50 characters long.
      Country String Get/Set the customer's country name.
      • Cannot be longer than 50 characters long.
      CountryID String Get/Set the customer's country ID from the country list. This is not part of the customer's address and is only used for reporting.
      • Cannot be NULL.
      • Cannot be empty.
      • Cannot be empty.
      • Cannot be longer than 50 characters long.
      County_State String Get/Set the customer's county or state name.
      • Cannot be longer than 50 characters long.
      CreationDate DateTime Get the date at which the stock item was created.
        CreditLimit Decimal Get/Set the customer credit limit.
          CreditTermID String Get/Set the customer's credit term identifier. The list of credit terms identifier can be obtained by calling the GetCreditTermList method.
          • Cannot be NULL.
          • Cannot be empty.
          • Cannot be longer than 50 characters long.
          CurrencyCode String Get/Set the customer's trading currency code.
          • Cannot be NULL.
          • Cannot be empty.
          • Cannot be longer than 50 characters long.
          DefaultTaxCode String Get/Set the customer's default tax code. It will be used if the Use account code checkbox is ticked in the front end.
          • Cannot be NULL.
          • Cannot be empty.
          • Cannot be longer than 50 characters long.
          DeliveryAddress1 String Get/Set the customer's first line of delivery address.
          • Cannot be longer than 50 characters long.
          DeliveryAddress2 String Get/Set the customer's second line of delivery address.
          • Cannot be longer than 50 characters long.
          DeliveryCity String Get/Set the customer's delivery city name.
          • Cannot be longer than 50 characters long.
          DeliveryContact String Get/Set the customer's delivery contact name.
          • Cannot be longer than 50 characters long.
          DeliveryCountry String Get/Set the customer's delivery country name.
          • Cannot be longer than 50 characters long.
          DeliveryCounty_State String Get/Set the customer's delivery county or state name.
          • Cannot be longer than 50 characters long.
          DeliveryFax String Get/Set the customer's delivery fax number.
          • Cannot be longer than 50 characters long.
          DeliveryName String Get/Set the customer's delivery name.
          • Cannot be longer than 50 characters long.
          DeliveryPhone String Get/Set the customer's delivery phone number.
          • Cannot be longer than 50 characters long.
          DeliveryPostCode String Get/Set the customer's delivery post code.
          • Cannot be longer than 50 characters long.
          DeliveryRouteID String Get/Set the customer's delivery route identifier.
          • Cannot be longer than 50 characters long.
          • Must be upper case.
          DepartmentID String Get/Set the customer's default department or tracking code identifier. This is used to tag transactions entered on the customer. This can be overwritten in the transaction entry screens.
          • Cannot be longer than 50 characters long.
          • Must be upper case.
          DiscountRate Decimal Get/Set the customer's default discount rate.
          • Cannot be negative.
          • Is expressed in percents and as such cannot be >= 1.
          EDICentralID String Get/Set the customer's central EDI identifier.
          • Cannot be longer than 50 characters long.
          Email String Get/Set the customer's email address.
          • Cannot be longer than 50 characters long.
          Fax String Get/Set the customer's fax number.
          • Cannot be longer than 50 characters long.
          GroupID String Get/Set the customer's group identifier.
          • Cannot be longer than 50 characters long.
          HeadOfficeAccountID String Get/Set the customer head office account ID. If this is set, the customer must be a branch of the specified head office account.
          • Cannot be longer than 50 characters long.
          Hold Int16 Get/Set the customer on hold status:
        • 0: not on hold
        • 1: on hold for orders
        • 2: on hold for orders and deliveries
          		•
            InternationalBankAccountNumber String Get/Set the customer's bank IBAN.
            • Cannot be longer than 50 characters long.
            IsActive Boolean Get/Set a flag indicating whether the customer is active or not.
              IsFranchise Boolean Get/Set a flag indicating if the customer is a franchisee or not. This is only used for franchisee/ franchisor order to quote synchronisation.
                IsHeadOffice Boolean Get/Set a flag indicating whether the customer is a head office account. If set, the customer is then eligible to be selected by a branch as its head office.
                  LedgerType LedgerType Get the LedgerType of the customer. For a customer this is always "Sales".
                    MobilePhone String Get/Set the customer's mobile phone number.
                    • Cannot be longer than 50 characters long.
                    Name String Get/Set the customer's name.
                    • Cannot be longer than 50 characters long.
                    Notes String Get/Set notes associated with the customer.
                    • Cannot be longer than 4000 characters long.
                    PaymentMethodID String Get/Set the customer's payment method identifier.
                    • Cannot be NULL.
                    • Cannot be empty.
                    • Cannot be longer than 50 characters long.
                    Phone String Get/Set the customer's phone number.
                    • Cannot be longer than 50 characters long.
                    PostCode String Get/Set the customer's post code.
                    • Cannot be longer than 50 characters long.
                    PriceCategoryID String Get/Set the customer's price category identifier. This will determine which set of prices apply to the customer on a stock item.
                    • Cannot be longer than 50 characters long.
                    • Must be upper case.
                    PriceListID String Get/Set the customer's price list identifier. This applies special pricing per customer based on quantity range and dates.
                    • Cannot be longer than 50 characters long.
                    • Must be upper case.
                    PriorityID String Get/Set the customer's priority identifier.
                    • Cannot be longer than 50 characters long.
                    • Must be upper case.
                    RegionID String Get/Set the customer's region identifier.
                    • Cannot be longer than 50 characters long.
                    • Must be upper case.
                    ShipViaID String Get/Set the customer's shipping via identifier.
                    • Cannot be longer than 50 characters long.
                    UseAccountTaxCode Boolean Get/Set a flag indicating whether the customer default tax code will be used over item tax codes when creating new invoices/orders/quotes from the front end.
                      UseHeadOffice Boolean Get/Set a flag indicating whether the customer uses the head office capabilities or not.
                        VATExemptReference String Get/Set the customer's tax exemption reference number.
                        • Cannot be longer than 50 characters long.
                        VATRegistrationNumber String Get/Set the customer's Tax registration number.
                        • Cannot be longer than 50 characters long.
                        WebAddress String Get/Set the customer's web site address.
                        • Cannot be longer than 50 characters long.
                        ⚠️ **GitHub.com Fallback** ⚠️