Если вы создаете еще два объекта DateTime, используя только год, месяц и день месяцев предыдущих дат, используя конструктор DateTime, он должен работать. Вот так:
DateTime date1,date2;//These should be initialized
Duration difference = DateTime(date1.year,date1.month,date1.day).diffrence (DateTime(date2.year,date2.month,date2.day));
print (diffrence.inDays);