v3 recurring bills changes
In v3, there are a range of improvements and new features with recurring bill operations.
v2 | v3 |
---|---|
Create a recurring bill with POST /v2/Crud/Create/RecurringBill.json .Pay each generated bill with POST /v2/PayBills.json . | Creating a recurring bill with POST /v3/recurringbills combines 3 operations.1. Set up recurring bills on a schedule. 2. In addition, you can enable auto-payment for each generated bill. 3. Add payment information for auto-payments. The request and response field names have changed. Relevant fields are grouped under the schedule , recurringBillLineItems , processingOptions , and paymentInformation objects.See Recurring bills for more information. |
Read a recurring bill with POST /v2/Crud/Read/RecurringBill.json . | Get recurring bill details with GET /v3/recurringbills/{recurringBillId} . recurringBillId is now set as a path parameter.See Get recurring bill details in the API reference for more information. |
List recurring bills with POST /v2/Crud/List/RecurringBill.json . | Get list of recurring bills with GET /v3/recurringbills .Filtering and sorting values are now query parameters. For filtering, use the filters=field:op:value format . The operator values are now acronyms. For example, = is now eq and >= is now gte .For sorting, use the sort=field:order format. For example, sort by createdTime in the ascending order with sort=createdTime:asc .The response includes nextPage and prevPage values for you to navigate between the pages of results.See Search operations with lists for more information. |
Update a recurring bill with POST /v2/Crud/Update/RecurringBill.json . | Replace a bill with PUT /v3/recurringbills/{recurringBillId} . This is a PUT operation and recurringBillId is now set as a path parameter.The request and response field names have changed. Use the v3 PUT operation to add, remove, or replace the number of line items in a recurring bill. You can also update other recurring bill details. The PUT operation replaces existing information with the updates in your request. Update a bill with PATCH /v3/recurringbills/{recurringBillId} . This is a PATCH operation and recurringBillId is now set as a path parameter.The request and response field names have changed. Use the v3 PATCH operation to modify existing line item details, such as amount and description . You can also update other recurring bill details.See Replace a recurring bill and Update a recurring bill in the API reference for more information. |
Delete a recurring bill with POST /v2/Crud/Delete/RecurringBill.json . | Archive a recurring bill with POST /v3/recurringbills/{recurringBillId}/archive . recurringBillId is now set as a path parameter.In the response, isActive is now archived . The archived field is boolean.See Archive a recurring bill in the API reference for more information. |
Undelete a recurring bill with POST /v2/Crud/Undelete/RecurringBill.json . | Restore a recurring bill with POST /v3/recurringbills/{recurringBillId}/restore . recurringBillId is now set as a path parameter.In the response, isActive is now archived . The archived field is boolean.See Restore an archived recurring bill in the API reference for more information. |
Updated 5 months ago