API Change Log - March 8th 2023 Release

Check out the API updates for this release.

Payments

• API endpoint: {apiurl}/v1/payments/billing_frequency?organization_id={org_id}
• Scenario: New API to retrieve billing frequencies of an organization
• Earlier behavior: NA
• New behavior: Use this API to fetch the billing frequencies of an organization. The billing frequencies are useful in determining the pricing model of the business.
• API documentation link: NA

Marketing

• API endpoint: {api_url}/v1/invoices/{invoice_id}/campaigns/auto_apply
• Scenario: New API to apply a campaign on an invoice automatically.
• Earlier behavior: NA
• New behavior: Use this API to automatically apply a campaign to a single or group invoice.
• API documentation link: NA

Reports v2

• API endpoint: {apiurl}/v1/reports/payroll/summary/flat_file
• Scenario: Added the following parameters to the response.

  break_time_hours

  vacation_hours

  vacation_pay_rate

  vacation_pay

  holiday_pay_rate

  holiday_hours

  holiday_pay

• Earlier behavior: The API fetched payroll summary report for the selected pay period.
• New behavior: The API will provide additional details apart from fetching the payroll summary report.
• API documentation link: NA

Employee

• API endpoint: {api_url}/v1/employees/{employee_id}?expand=payroll_info
• Scenario: Added the following parameters to the response object:

  vacation_pay_rate

  holiday_pay_rate

• Earlier behavior: The API fetched employee details such as personal info, contact details, job info, and preference info.
• New behavior: With this update, the API will also fetch details such as vacation_pay_rate, and holiday_pay_rate.
• API documentation link: Retrieve employee details with payroll information.

API endpoint: {api_url}/v1/employees/{employee_id}

• Scenario: Added the following parameters to the response object:

  vacation_pay_rate

  holiday_pay_rate

• Earlier behavior: The API updated the employee details such as login, job, preference, and payroll information.
• New behavior: With this update, in the response object, the API will contain vacation_pay_rate and the holiday_pay_rate.
• API documentation link: Update an employee of the center.

• API endpoint: {api_url}/v1/employees?expand=payroll_info
• Scenario: Added the following parameters to the response object:

  vacation_pay_rate

  holiday_pay_rate

• Earlier behavior: The API created a new employee in the center.
• New behavior: With this update, in the response object, the API will contain vacation_pay_rate and holiday_pay_rate.
• API documentation link: Add employee with catalog information.