Finance APIs
Deletes payment item
| HTTP method | DELETE |
| URI | https://api.rambase.net/finance/payments/{paymentId}/items/{itemId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {paymentId} |
Payment identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Item-/line-number of the payment.
Integer, minimum 1 |
| Successful HTTP status code | 202 |
| API resource identifier | 6708, version 1 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100182 HTTP 404 | Payment {0} not found |
| Error 106202 HTTP 400 | Payment can't be registered as payment has batchjob(s) running |
| Error 106203 HTTP 400 | Payment can't be reopened as payment has batchjob(s) running |
| Error 106204 HTTP 400 | Payment can't be revised as payment has batchjob(s) running |
| Error 109838 HTTP 400 | Payment item can't be deleted as payment has batchjob(s) running |
| Error 106199 HTTP 400 | Payment can't be registered as payment has financejobs not executed |
| Error 106200 HTTP 400 | Payment can't be reopened as payment has financejobs not executed |
| Error 106201 HTTP 400 | Payment can't be revised as payment has financejobs not executed |
| Error 109837 HTTP 400 | Payment item can't be deleted as payment has financejobs not executed |