API

Finance APIs

GET finance/payments/{paymentId}

Payment details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/payments/{paymentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {paymentId} Payment identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 510, version 9

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
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select 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
<Payment>
2
     <PaymentId
PaymentId

Payment identifier

>{Integer}</PaymentId>
3
     <Status
Status

Status of payment

Possible domain values can be found here

>{Integer}</Status>
4
     <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
5
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
6
     <CurrencyDate
CurrencyDate

Currency date of the transaction

>{Date}</CurrencyDate>
7
     <Bank>
8
          <BankId
BankId

Bank account identifier

>{Integer}</BankId>
9
          <Name
Name

Name of bank account

>{String}</Name>
10
          <BankLink
BankLink

Bank reference

>{String}</BankLink>
11
     </Bank>
12
     <AccountingPeriod>
13
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
14
          <Period
Period

Accounting period

>{Integer}</Period>
15
          <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
16
     </AccountingPeriod>
17
     <Totals>
18
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
19
          <TotalAmount
TotalAmount

Total amount

>{Decimal}</TotalAmount>
20
     </Totals>
21
</Payment>
1
{
2
     "payment": {
3
          "paymentId
PaymentId

Payment identifier

": "{Integer}",
4
          "status
Status

Status of payment

Possible domain values can be found here

": "{Integer}",
5
          "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
6
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
7
          "currencyDate
CurrencyDate

Currency date of the transaction

": "{Date}",
8
          "bank": {
9
               "bankId
BankId

Bank account identifier

": "{Integer}",
10
               "name
Name

Name of bank account

": "{String}",
11
               "bankLink
BankLink

Bank reference

": "{String}"
12
          },
13
          "accountingPeriod": {
14
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
15
               "period
Period

Accounting period

": "{Integer}",
16
               "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
17
          },
18
          "totals": {
19
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
20
               "totalAmount
TotalAmount

Total amount

": "{Decimal}"
21
          }
22
     }
23
}

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