Package net.amcintosh.freshbooks.models

Class Client

java.lang.Object
java.util.AbstractMap<String,Object>
com.google.api.client.util.GenericData
com.google.api.client.json.GenericJson
net.amcintosh.freshbooks.models.Client
All Implemented Interfaces:
Cloneable, Map<String,Object>, ConvertibleContent
public class Client extends com.google.api.client.json.GenericJson implements ConvertibleContent
A client in the new FreshBooks is a resource representing an entity you send invoices to.
See Also:

  • Constructor Details

    • Client

      public Client()

  • Method Details

    • getId

      public long getId()
      Get the unique identifier of this client within this business.
      Returns:
      Client Id

    • getAccountingSystemId

      public String getAccountingSystemId()
      Get unique identifier of business client exists on.
      Returns:
      Accounting System Id

    • getBusinessPhone

      public String getBusinessPhone()
      Business phone number.
      Returns:
      String of the phone number

    • setBusinessPhone

      public void setBusinessPhone(String businessPhone)
      Business phone number.
      Parameters:
      businessPhone - String of the phone number

    • getCompanyIndustry

      public String getCompanyIndustry()
      Description of industry client is in.
      Returns:
      The industry

    • setCompanyIndustry

      public void setCompanyIndustry(String companyIndustry)
      Description of industry client is in.
      Parameters:
      companyIndustry - The industry

    • getCompanySize

      public String getCompanySize()
      Size of client's company
      Returns:
      Eg. "10"

    • setCompanySize

      public void setCompanySize(String companySize)
      Size of client's company
      Parameters:
      companySize - Eg. "10"

    • getCurrencyCode

      public String getCurrencyCode()
      3-letter shortcode for client's preferred currency. Eg. USD, CAD, EUR
      Returns:
      Eg. "USD"

    • setCurrencyCode

      public void setCurrencyCode(String currencyCode)
      3-letter shortcode for client's preferred currency. Eg. USD, CAD, EUR
      Parameters:
      currencyCode - Eg. "USD"

    • getEmail

      public String getEmail()
      Client's email.
      Returns:
      The email

    • setEmail

      public void setEmail(String email)
      Client's email.
      Parameters:
      email - The email

    • getFax

      public String getFax()
      Client's fax number.
      Returns:
      Eg. "416-444-4444"

    • setFax

      public void setFax(String fax)
      Client's fax number.
      Parameters:
      fax - Eg. 416-444-4444

    • getFirstName

      public String getFirstName()
      Client's first name.
      Returns:
      Eg. "Gordon"

    • setFirstName

      public void setFirstName(String firstName)
      Client's first name.
      Parameters:
      firstName - Eg. "Gordon"

    • getHomePhone

      public String getHomePhone()
      Client's home phone number.
      Returns:
      Eg. 416-444-4444

    • setHomePhone

      public void setHomePhone(String homePhone)
      Client's home phone number.
      Parameters:
      homePhone - Eg. 416-444-4444

    • getLanguage

      public String getLanguage()
      Shortcode indicating user language e.g. "en"
      Returns:
      Eg. "en"

    • setLanguage

      public void setLanguage(String language)
      Shortcode indicating user language e.g. "en"
      Parameters:
      language - Eg. "en"

    • getLastActivity

      public String getLastActivity()
      The last client activity action.

      Note: This returns as "null" in all calls unless a "last_activity" include parameter is provided.
      Returns:
      eg. "Client Updated"

    • getLastName

      public String getLastName()
      Client's last name.
      Returns:
      Eg. "Shumway"

    • setLastName

      public void setLastName(String lastName)
      Client's last name.
      Parameters:
      lastName - Eg. "Shumway"

    • getMobilePhone

      public String getMobilePhone()
      Client's mobile phone number.
      Returns:
      Eg. "416-444-4444"

    • setMobilePhone

      public void setMobilePhone(String mobilePhone)
      Client's mobile phone number.
      Parameters:
      mobilePhone - Eg. "416-444-4444"

    • getNote

      public String getNote()
      Notes kept by admin about client.
      Returns:
      The notes

    • setNote

      public void setNote(String note)
      Notes kept by admin about client.
      Parameters:
      note - The notes

    • getOrganization

      public String getOrganization()
      Name for client's business.
      Returns:
      Organization name

    • setOrganization

      public void setOrganization(String organization)
      Name for client's business.
      Parameters:
      organization - Organization name

    • getBillingCity

      public String getBillingCity()
      Billing address city.
      Returns:
      The city

    • setBillingCity

      public void setBillingCity(String billingCity)
      Billing address city.
      Parameters:
      billingCity - The city

    • getBillingCode

      public String getBillingCode()
      Billing address postal code.
      Returns:
      The postal code

    • setBillingCode

      public void setBillingCode(String billingCode)
      Billing address postal code.
      Parameters:
      billingCode - The postal code

    • getBillingCountry

      public String getBillingCountry()
      Billing address country.
      Returns:
      The country

    • setBillingCountry

      public void setBillingCountry(String billingCountry)
      Billing address country.
      Parameters:
      billingCountry - The country

    • getBillingProvince

      public String getBillingProvince()
      Short form of province for billing address.
      Returns:
      The province/state

    • setBillingProvince

      public void setBillingProvince(String billingProvince)
      Short form of province for billing address.
      Parameters:
      billingProvince - The province/state

    • getBillingStreet

      public String getBillingStreet()
      Billing address street.
      Returns:
      The street address.

    • setBillingStreet

      public void setBillingStreet(String billingStreet)
      Billing address street.
      Parameters:
      billingStreet - The street address.

    • getBillingStreet2

      public String getBillingStreet2()
      Billing address, additional street info.
      Returns:
      The street address.

    • setBillingStreet2

      public void setBillingStreet2(String billingStreet2)
      Billing address, second street info.
      Parameters:
      billingStreet2 - The street address.

    • getShippingCity

      public String getShippingCity()
      Shipping address city.
      Returns:
      The city

    • setShippingCity

      public void setShippingCity(String shippingCity)
      Shipping address city.
      Parameters:
      shippingCity - The city

    • getShippingCode

      public String getShippingCode()
      Shipping address postal code.
      Returns:
      The postal code

    • setShippingCode

      public void setShippingCode(String shippingCode)
      Shipping address postal code.
      Parameters:
      shippingCode - The postal code

    • getShippingCountry

      public String getShippingCountry()
      Shipping address country.
      Returns:
      The country

    • setShippingCountry

      public void setShippingCountry(String shippingCountry)
      Shipping address country.
      Parameters:
      shippingCountry - The country

    • getShippingProvince

      public String getShippingProvince()
      Short form of province for shipping address.
      Returns:
      The province/state

    • setShippingProvince

      public void setShippingProvince(String shippingProvince)
      Short form of province for shipping address.
      Parameters:
      shippingProvince - The province/state

    • getShippingStreet

      public String getShippingStreet()
      Shipping address street.
      Returns:
      The address

    • setShippingStreet

      public void setShippingStreet(String shippingStreet)
      Shipping address street.
      Parameters:
      shippingStreet - The address

    • getShippingStreet2

      public String getShippingStreet2()
      Shipping address, second street info.
      Returns:
      The address

    • setShippingStreet2

      public void setShippingStreet2(String shippingStreet2)
      Shipping address, second street info.
      Parameters:
      shippingStreet2 - The address

    • getUserId

      public long getUserId()
      Duplicate of id
      Returns:
      The id

    • getVatName

      public String getVatName()
      Get the "Value Added Tax" name
      Returns:
      VAT name

    • setVatName

      public void setVatName(String vatName)
      Set the "Value Added Tax" name
      Parameters:
      vatName - VAT name

    • getVatNumber

      public String getVatNumber()
      Get the "Value Added Tax" number
      Returns:
      VAT number

    • setVatNumber

      public void setVatNumber(String vatNumber)
      Set the "Value Added Tax" number
      Parameters:
      vatNumber - VAT number

    • getSignupDate

      public ZonedDateTime getSignupDate()
      Get the signup time of the client.

      Note: The API returns this data in UTC.
      Returns:
      Signup time in UTC

    • getUpdated

      public ZonedDateTime getUpdated()
      Get the time of last modification to the client.

      Note: The API returns this data in "US/Eastern", but it is converted to UTC.
      Returns:
      Updated time in UTC

    • getVisState

      public VisState getVisState()
      Get the visibility state: active, deleted, or archived

      Returns:
      Enum of the visibility state.
      See Also:

    • setVisState

      public void setVisState(VisState visState)
      Set the visibility state of the client.

      Parameters:
      visState - VisState value
      See Also:

    • getContent

      public Map<String,Object> getContent()
      Description copied from interface: ConvertibleContent
      Return the objects values as a Map suitable to sending to FreshBooks in a POST or PUT request.
      Specified by:
      getContent in interface ConvertibleContent
      Returns: