API

Finance APIs

GET finance/receivable-journal-entries/{receivableJournalEntryId}

Receivable journal entry details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/receivable-journal-entries/{receivableJournalEntryId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {receivableJournalEntryId} Receivable journal entry identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 643, version 12

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.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable 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
<ReceivableJournalEntry>
2
     <ReceivableJournalEntryId
ReceivableJournalEntryId

Receivable journal entry identifier

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

Status of receivable journal entry

Possible domain values can be found here

>{String}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Remark
Remark

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Remark>
6
     <Source>
7
          <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
8
          <Object>
9
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
11
               <RegistrationDate
RegistrationDate

Date of registration

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

Date when the document was issued.

>{Date}</IssueDate>
13
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
14
          </Object>
15
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
16
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
17
     </Source>
18
     <Customer>
19
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
20
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
21
          <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
22
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
23
     </Customer>
24
     <InterCompany>
25
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
26
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
27
          <Name
Name

Name of company

>{String}</Name>
28
          <LegalEntityIdentifier
LegalEntityIdentifier

The company's unique enterprise/organization number.

>{String}</LegalEntityIdentifier>
29
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
30
     </InterCompany>
31
     <GeneralLedgerPosting>
32
          <GeneralLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

>{Integer}</GeneralLedgerPostingId>
33
          <GeneralLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

>{String}</GeneralLedgerPostingLink>
34
     </GeneralLedgerPosting>
35
     <AccountingPeriod>
36
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

>{String}</AccountingPeriodLink>
39
     </AccountingPeriod>
40
     <Totals>
41
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount

>{Decimal}</TotalAmount>
43
          <TotalCreditAmount
TotalCreditAmount

Total debit amount.

This field is greyed out because it is an expandable field. You have to add $expand=Totals.TotalCreditAmount in your request URI to get this field

>{Decimal}</TotalCreditAmount>
44
          <TotalDebitAmount
TotalDebitAmount

Total credit amount.

This field is greyed out because it is an expandable field. You have to add $expand=Totals.TotalDebitAmount in your request URI to get this field

>{Decimal}</TotalDebitAmount>
45
     </Totals>
46
     <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>
47
          <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{String}</Currency>
48
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
49
          <TotalAmount
TotalAmount

Total amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
50
          <TotalCreditAmount
TotalCreditAmount

Total debit amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalCreditAmount>
51
          <TotalDebitAmount
TotalDebitAmount

Total credit amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalDebitAmount>
52
     </TotalsConverted>
53
     <VATDetails>
54
          <VATType
VATType

Type of value added tax

>{String}</VATType>
55
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

>{String}</VATHandling>
56
          <VATRegistrationNumber
VATRegistrationNumber

The customers unique enterprise/organization number.

>{String}</VATRegistrationNumber>
57
          <Totals>
58
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Value added tax gross amount.

>{Decimal}</TotalAmount>
60
          </Totals>
61
          <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

>
62
               <Currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

>{String}</Currency>
63
               <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
64
               <TotalAmount
TotalAmount

Value added tax gross amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
65
          </TotalsConverted>
66
     </VATDetails>
67
     <Location>
68
          <LocationId
LocationId

Location identifier

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationId in your request URI to get this field

>{Integer}</LocationId>
69
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
70
          <Address
Address

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

>
71
               <Country
Country

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

>{String}</Country>
72
               <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

>{String}</CountryCode>
73
          </Address>
74
          <LocationLink
LocationLink

Location reference

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationLink in your request URI to get this field

>{String}</LocationLink>
75
     </Location>
76
     <ShipmentCountry
ShipmentCountry

This field is greyed out because it is an expandable field. You have to add $expand=ShipmentCountry in your request URI to get this field

>
77
          <Name
Name

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=ShipmentCountry in your request URI to get this field

>{String}</Name>
78
          <CountryCode
CountryCode

Country code of shipment destination

This field is greyed out because it is an expandable field. You have to add $expand=ShipmentCountry in your request URI to get this field

>{String}</CountryCode>
79
     </ShipmentCountry>
80
     <InvoiceCountry
InvoiceCountry

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceCountry in your request URI to get this field

>
81
          <Name
Name

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceCountry in your request URI to get this field

>{String}</Name>
82
          <CountryCode
CountryCode

Country code for invoice address

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceCountry in your request URI to get this field

>{String}</CountryCode>
83
     </InvoiceCountry>
84
</ReceivableJournalEntry>
1
{
2
     "receivableJournalEntry": {
3
          "receivableJournalEntryId
ReceivableJournalEntryId

Receivable journal entry identifier

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

Status of receivable journal entry

Possible domain values can be found here

": "{String}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "remark
Remark

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",
7
          "source": {
8
               "itemId
ItemId

Identifier of the object

": "{Integer}",
9
               "object": {
10
                    "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
12
                    "registrationDate
RegistrationDate

Date of registration

": "{Date}",
13
                    "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
14
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
15
               },
16
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
17
               "itemLink
ItemLink

API reference to the item

": "{String}"
18
          },
19
          "customer": {
20
               "customerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
22
               "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
23
               "customerLink
CustomerLink

Customer reference

": "{String}"
24
          },
25
          "interCompany": {
26
               "companyId
CompanyId

Company identifier

": "{Integer}",
27
               "database
Database

Abbreviation/code to identify the company

": "{String}",
28
               "name
Name

Name of company

": "{String}",
29
               "legalEntityIdentifier
LegalEntityIdentifier

The company's unique enterprise/organization number.

": "{String}",
30
               "companyLink
CompanyLink

Company reference

": "{String}"
31
          },
32
          "generalLedgerPosting": {
33
               "generalLedgerPostingId
GeneralLedgerPostingId

General ledger posting identifier

": "{Integer}",
34
               "generalLedgerPostingLink
GeneralLedgerPostingLink

General ledger posting reference

": "{String}"
35
          },
36
          "accountingPeriod": {
37
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

": "{String}"
40
          },
41
          "totals": {
42
               "currency
Currency

Three character code following the ISO 4217 standard

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

Total amount

": "{Decimal}",
44
               "totalCreditAmount
TotalCreditAmount

Total debit amount.

This field is greyed out because it is an expandable field. You have to add $expand=Totals.TotalCreditAmount in your request URI to get this field

": "{Decimal}",
45
               "totalDebitAmount
TotalDebitAmount

Total credit amount.

This field is greyed out because it is an expandable field. You have to add $expand=Totals.TotalDebitAmount in your request URI to get this field

": "{Decimal}"
46
          },
47
          "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": {
48
               "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{String}",
49
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
50
               "totalAmount
TotalAmount

Total amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
51
               "totalCreditAmount
TotalCreditAmount

Total debit amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
52
               "totalDebitAmount
TotalDebitAmount

Total credit amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}"
53
          },
54
          "vATDetails": {
55
               "vATType
VATType

Type of value added tax

": "{String}",
56
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

": "{String}",
57
               "vATRegistrationNumber
VATRegistrationNumber

The customers unique enterprise/organization number.

": "{String}",
58
               "totals": {
59
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Value added tax gross amount.

": "{Decimal}"
61
               },
62
               "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

": {
63
                    "currency
Currency

Three character code following the ISO 4217 standard

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

": "{String}",
64
                    "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

": "{Decimal}",
65
                    "totalAmount
TotalAmount

Value added tax gross amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=VATDetails.TotalsConverted in your request URI to get this field

": "{Decimal}"
66
               }
67
          },
68
          "location": {
69
               "locationId
LocationId

Location identifier

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationId in your request URI to get this field

": "{Integer}",
70
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
71
               "address
Address

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

": {
72
                    "country
Country

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

": "{String}",
73
                    "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

": "{String}"
74
               },
75
               "locationLink
LocationLink

Location reference

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationLink in your request URI to get this field

": "{String}"
76
          },
77
          "shipmentCountry
ShipmentCountry

This field is greyed out because it is an expandable field. You have to add $expand=ShipmentCountry in your request URI to get this field

": {
78
               "name
Name

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=ShipmentCountry in your request URI to get this field

": "{String}",
79
               "countryCode
CountryCode

Country code of shipment destination

This field is greyed out because it is an expandable field. You have to add $expand=ShipmentCountry in your request URI to get this field

": "{String}"
80
          },
81
          "invoiceCountry
InvoiceCountry

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceCountry in your request URI to get this field

": {
82
               "name
Name

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceCountry in your request URI to get this field

": "{String}",
83
               "countryCode
CountryCode

Country code for invoice address

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceCountry in your request URI to get this field

": "{String}"
84
          }
85
     }
86
}

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 100141 HTTP 404 Country not found
Error 100055 HTTP 403 You have only admittance to your own objects