× Freshbooks App Logo
FreshBooks
Official App
Free - Google Play
Get it

Default Terms

Staff have access to the API calls listed below if the Invoices tab is enabled for staff.

  • default_terms.list
  • default_terms.get
  • default_terms.update
  • default_terms.list

    Return a list of default terms for invoices, estimates and credits.

    Request

    <?xml version="1.0" encoding="utf-8"?>
    <request method="default_terms.list"></request>
    

    Response

    <?xml version="1.0" encoding="utf-8"?>
    <response xmlns="https://www.freshbooks.com/api/" status="ok">
    	<default_terms>
    	<terms>
    		<type>invoice</type>
    		<message>Sample Terms</message>
    	</terms>
    	<terms>
    		<type>estimate</type>
    		<message>Sample Terms</message>
    	</terms>
    	<terms>
    		<type>credit</type>
    		<message>Sample Terms</message>
    	</terms>
    	</default_terms>
    </response>
    

    default_terms.get

    Return default terms for the specified class of object (invoice, estimate or credit).

    Request

    <?xml version="1.0" encoding="utf-8"?>
    <request method="default_terms.get">
    	<type>invoice</type> <!--(Required) 'invoice', 'estimate', or 'credit'-->
    </request>
    

    Response

    <?xml version="1.0" encoding="utf-8"?>
    <response xmlns="https://www.freshbooks.com/api/" status="ok">
    	<terms>
    		<type>invoice</type>
    		<message>Sample Terms</message>
    	</terms>
    </response>
    

    default_terms.update

    Update default terms for the specified class of object.

    Request

    <?xml version="1.0" encoding="utf-8"?>
    <request method="default_terms.update">
    	<terms>
    		<type>estimate</type>
    		<message>New Terms</message>
    	</terms>
    </request>
    

    Response

    <?xml version="1.0" encoding="utf-8"?>
    <response xmlns="https://www.freshbooks.com/api/" status="ok"/></response>