Project schedules are used to manage the escrow account throughout the project lifecycle
PayKeeper's automated escrow platform requires that projects have defined schedules for milestones, payouts and other items that are binding to the escrow agreement between companies using PayKeeper and their customers.
Project schedule templates are created for a company during the onboarding process. For many companies, one template is sufficient for all of their projects. Other companies need multiple templates to support different types of projects.
When creating a project, you can optionally provide the project schedule template to use to create that project. This is passed as an argument to the create project API projectScheduleTemplateId. Although not typically required, there are a few cases you should be aware of if this applies to your organization:
- The template is not required if you only have one project schedule template
- If you have multiple project schedule templates, then you should provide the desired project schedule template id. This is considered best practice. Make a
GETrequest to/api/public/project-schedule-templatesto see a list of available project schedule templates that your organization can use. - Default Project Schedule Templates: If your company has multiple project schedule templates, you can configure a default template during the onboarding process with PayKeeper. This would be used in cases where no project schedule template id has been provided while creating a project. Reach out if you run into issues or need to change the default schedule.
- Fallback scenarios: If you have multiple project schedule templates and do NOT provide an id, the system will fallback to the default project schedule template for your organization. If a default is not configured, then the system will return an
errorand a project will not be created. If you would like to configure a default, please contact PayKeeper support.
