DEFRA / sroc-service-team

Guides, info and issue management for the Charging Module Team
Other
0 stars 1 forks source link

Update admin generate bill run OpenAPI details #103

Closed Cruikshanks closed 3 years ago

Cruikshanks commented 3 years ago

https://github.com/DEFRA/sroc-charging-module-api/pull/570

We've updated the test generate bill run endpoint in the API

The last is the critical change. Previously, the generator determined just how many transactions were assigned to each invoice (currently 3). Recently, we have had a need to create bill runs for test purposes that have much larger numbers of transactions. It's not just about lots of invoices (great for /generate testing), but invoices with lots of transactions (needed for DELETE testing).

So, to remain consistent we still by default add 3 transactions per invoice. But now you can multiply that by a value. For example, a transactionMultiplier of 3 for a zero-value invoice would result in 9 transactions being created and assigned to the invoice.

This change updates the OpenAPI documentation to reflect these changes.