Create

schedules.create

Creates a new schedule. It also allows you to create a new client and/or items in the same request.

If the client name does not exist a new one is created. Regarding item taxes, if the tax name is not found, it is ignored and no tax is applied to that item.

If no item exists with the given name a new one will be created.

If the item exists it will be updated with the new values.

Be careful when updating the schedule items, as any missing items from the original schedule are deleted.

You call this method by submitting an HTTP POST request to the following URL with the XML data of the new schedule on the request body:

https://{account-name}.app.invoicexpress.com/schedules.xml

Header

Content-Type: application/xml; charset=utf-8

Body

<schedule>
  <start_date>30/10/2009</start_date>
  <end_date>30/10/2020</end_date>
  <create_back>Yes</create_back>
  <schedule_type>Monthly</schedule_type>
  <interval>2</interval>
  <send_to_client>Yes</send_to_client>
  <description>One description</description>
  <invoice_template>
    <date>30/10/2009</date>
    <due_date>31/10/2009</due_date>
    <due_days>0</due_days>
    <reference></reference>
    <observations></observations>
    <retention></retention>
    <client>
      <name>Client</name>
      <email>someone@example.com</email>
      <address></address>
      <postal_code></postal_code>
      <fiscal_id></fiscal_id>
    </client>
    <items type="array">
      <item>
        <name>Product x</name>
        <description></description>
        <unit_price>0.0</unit_price>
        <quantity>3.0</quantity>
        <tax>
          <name>IVA20</name>
        </tax>
        <discount>0.0</discount>
      </item>
      <item>
        <name>Product y</name>
        <description></description>
        <unit_price>0.0</unit_price>
        <quantity>3.0</quantity>
        <tax>
          <name>IVA20</name>
        </tax>
        <discount>0.0</discount>
      </item>
    </items>
  </invoice_template>
</schedule>

Parameters

Parameters are the data you will pass with the call.

Return Values

These are the results that will be returned on success and error.

Success

HTTP: 201 CREATED

<schedule>
   <id>26</id>
   <next_date>30/01/2010</next_date>
   <next_due_date>30/01/2010</next_due_date>
   <reference></reference>
   <observations></observations>
   <retention>4.0</retention>
   <client>
     <name>Client</name>
     <email>someone@example.com</email>
     <address></address>
     <postal_code></postal_code>
     <fiscal_id></fiscal_id>
   </client>
   <currency>Euro</currency>
   <items>
     <item>
       <id>21</id>
       <name>Product x</name>
       <description></description>
       <unit_price>3.0</unit_price>
       <quantity>2.0</quantity>
       <tax>
         <name>IVA20</name>
         <value>20.0</value>
       </tax>
       <discount>4.0</discount>
     </item>
     <item>
       <id>16</id>
       <name>Product y</name>
       <description></description>
       <unit_price>0.0</unit_price>
       <quantity>3.0</quantity>
       <tax>
         <name>IVA20</name>
         <value>20.0</value>
       </tax>
       <discount>0.0</discount>
     </item>
   </items>
   <sum>6.0</sum>
   <discount>0.24</discount>
   <before_taxes>5.76</before_taxes>
   <taxes>1.15</taxes>
   <total>6.68</total>
 </schedule>

Error

Possible errors for HTTP: 422

<errors>
 <error>Invoice is invalid</error>
 <error>Interval must be greater than 0</error>
 <error>Invoice items is invalid</error>
 <error>Client is invalid</error>
 <error>Due date must be later than date</error>
 <error>Email must be an email address</error>
 <error>Discount is not a number</error>
 <error>Quantity must be a number greater than 0</error>
 <error>Unit_price must be a number</error>
</errors>