Retainer Budgets in POST API Calls

Developer Forum
1

Dear all,

We are trying to create projects with retainer budgets via API. Currently, I can only use GET requests to retrieve all retainers according to your documentation (Endpoint to get all retainers for a project. | awork API | Documentation).

What we would like to achieve: Creating a retainer project and assign a monthly budget with carry over options to this project. Is there an API which we can use to do so?

Best regards

1 Like
2

@ian can you have a look here? Is it possible to get a POST-Endpoint in order to create a retainer project?

Thanks in advance
Chris

3

Hi @nico.hakenes and @chris.uhrig,

thanks for letting me know. I will check with the team if we can also make those endpoints available for external API clients.

Will get back to you soon!

Best regards
Ian

1 Like
4

@ian : Sorry to bother you — just checking in to see if there are any updates on the endpoint? We’re under a bit of pressure, as it’s needed to fulfill a customer requirement.

Really appreciate your support!

Best regards,
Chris

5

Hi @chris.uhrig ,
the retainer endpoints are already available for external API clients however I didn’t manage to update the developer docs yet due to the docs release.
The Post model includes the following properties:

  • TimeBudget (int in sec)
  • Timezone (please use Etc/Utc for now)
  • RollOverUnderspentBudget (bool)
  • RollOverOverspentBudget (bool)
  • StartDate (DateTime, should be in UTC and in 00:00:00 of the first day of the month)
  • EndDate (DateTime, should be in UTC and 23:59:59 the last day of the ending month)
  • SyncProjectDates (bool, if the dates should be synced with the project, there can only be one synced retainer per project at time)

Otherwise, you can always check the request models by inspecting the network tab when creating a retainer via the web app. I hope with this info you can already start the implementation. I will update the dev docs next week once I am back from vacation.
If there are any questions pls let me know.
Best regards
Ian

1 Like
6

Thanks, we will test it but looks very promising :folded_hands: