v3 bills changes
In v3, there are a range of improvements and new features with bill operations.
v2 | v3 |
---|---|
Create a bill with POST /v2/Crud/Create/Bill.json .For international vendors, retrieve the BILL exchange rate with POST /v2/GetDynamicExchangeRateQuote.json .When you create a bill for an international vendor, you must set the exchange rate in your request. | Create a bill with POST /v3/bills .The request and response field names have changed. Relevant fields are grouped under the billLineItems and invoice objects.When you create a bill for an international vendor, the local currency amount and exchange rate are calculated automatically based on the USD funding amount. See Bills for more information. |
Read a bill with POST /v2/Crud/Read/Bill.json . | Get bill details with GET /v3/bills/{billId} . billId is now set as a path parameter.See Get bill details in the API reference for more information. |
List bills with POST /v2/Crud/List/Bill.json . | Get list of bills with GET /v3/bills .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 bill with POST /v2/Crud/Update/Bill.json . | Replace a bill with PUT /v3/bills/{billId} . This is a PUT operation and billId 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 bill. You can also update other bill details. The PUT operation replaces existing information with the updates in your request. Update a bill with PATCH /v3/bills/{billId} . This is a PATCH operation and billId 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 bill details.See Replace a bill and Update a bill in the API reference for more information. |
Delete a bill with POST /v2/Crud/Delete/Bill.json . | Archive a bill with POST /v3/bills/{billId}/archive . billId is now set as a path parameter.In the response, isActive is now archived . The archived field is boolean.See Archive a bill in the API reference for more information. |
Undelete a bill with POST /v2/Crud/Undelete/Bill.json . | Restore a bill with POST /v3/bills/{billId}/restore . billId is now set as a path parameter.In the response, isActive is now archived . The archived field is boolean.See Restore an archived bill in the API reference for more information. |
Updated 5 months ago