GET /settlements/new
Creates a settlement object with all configured defaults set. This doesn't create a record
in the database. Instead, callers of this method can edit the returned object and then
pass it back to the create method to actually insert the record in the database.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| dispatchId |
Order number or manifest number of the settlement. Populates information in the new settlement object from the provided dispatchId |
query
|
|
String
|
Result
RowSettlement
of type:
application/xml
application/json
a settlement record with all appropriate defaults set.
Try It Out
Request