API

Finance APIs

PUT finance/payments/{paymentId}/items/{itemId}

Saves information about the payment item

HTTP method PUT
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 200
API resource identifier 6662, version 8

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.

Format:
1
<PaymentItem
PaymentItem

This field is optional.

>
2
     <Note
Note

Payment item note

This field is optional.

>{String}</Note>
3
     <Counterparty
Counterparty

The customer or supplier involved in the payment item

This field is optional.

>
4
          <ObjectId
ObjectId

Identifier of the object

Minimum value: 100

This field is optional.

>{Integer}</ObjectId>
5
          <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
6
     </Counterparty>
7
     <Intercompany
Intercompany

This field is optional.

>
8
          <Code
Code

Intercompany database the customer belongs to.

This field is optional.

>{String}</Code>
9
     </Intercompany>
10
     <Totals
Totals

This field is optional.

>
11
          <TotalAmount
TotalAmount

Total paid amount

This field is optional.

>{Decimal}</TotalAmount>
12
     </Totals>
13
</PaymentItem>
1
{
2
     "paymentItem
PaymentItem

This field is optional.

": {
3
          "note
Note

Payment item note

This field is optional.

": "{String}",
4
          "counterparty
Counterparty

The customer or supplier involved in the payment item

This field is optional.

": {
5
               "objectId
ObjectId

Identifier of the object

Minimum value: 100

This field is optional.

": "{Integer}",
6
               "objectType
ObjectType

Type of object

This field is optional.

": "{String}"
7
          },
8
          "intercompany
Intercompany

This field is optional.

": {
9
               "code
Code

Intercompany database the customer belongs to.

This field is optional.

": "{String}"
10
          },
11
          "totals
Totals

This field is optional.

": {
12
               "totalAmount
TotalAmount

Total paid amount

This field is optional.

": "{Decimal}"
13
          }
14
     }
15
}

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.

Format:
1
1

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 104870 HTTP 404 Default account assignment not found
Error 100141 HTTP 404 Country not found
Error 104869 HTTP 404 Default account not found