API

Finance APIs

GET system/reports/100047/result-set?excludeClearingPay={excludeClearingPay}

Supplier account transactions

Report name Supplier account movements
Report identifier 100047
HTTP method GET
URI https://api.rambase.net/system/reports/100047/result-set?excludeClearingPay={excludeClearingPay}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 20
Successful HTTP status code 200
API resource identifier 4111, version 10

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.

excludeClearingPay Boolean, optional Exclude Clearing transactions from report listing
$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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
BuyersReferenceNumber String Buyers reference number.
Currency String Three character code following the ISO 4217 standard.
CustomerIntercompanyCode String Intercompany database the customer belongs to.
DueDate Date Date the object is due to be paid. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
InvoiceAddressCountryCode String Two-character code (ISO 3166) identifying the country.
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PaymentId Integer Payment identifier.
PaymentItemId Integer Item-/line-number of the payment.
PaymentTerms String Terms of payment. Defaut value is retrieved from the supplier..
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ShippingAddressCountryCode String Two-character code (ISO 3166) identifying the country.
Status String Status of accounts payable transaction.
SupplierId Integer RamBase supplier identifier.
SuppliersInvoiceNumber String Suppliers/sellers reference number. Typically to an external system.
TotalAmount Decimal Total amount.
TotalsConvertedTotalAmount Decimal Total amount in company currency.
TotalsConvertedVATAmount Decimal Value added tax amount in company currency.
VATAmount Decimal Total value added tax in object currency.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

Read more about filters and sorting on how to use sortable parameters

AccountingPeriod Integer Accounting period
BuyersReferenceNumber String Buyers reference number
Currency String Three character code following the ISO 4217 standard
CustomerIntercompanyCode String Intercompany database the customer belongs to.
DueDate Date Date the object is due to be paid
InvoiceAddressCountryCode String Two-character code (ISO 3166) identifying the country.
IssueDate Date Date when the document was issued.
PaymentId Integer Payment identifier
PaymentItemId Integer Item-/line-number of the payment.
PaymentTerms String Terms of payment. Defaut value is retrieved from the supplier.
RegistrationDate Date Date of registration
ShippingAddressCountryCode String Two-character code (ISO 3166) identifying the country.
Status String Status of accounts payable transaction
SupplierId Integer RamBase supplier identifier
TotalAmount Decimal Total amount
TotalsConvertedTotalAmount Decimal Total amount in company currency.
TotalsConvertedVATAmount Decimal Value added tax amount in company currency.
VATAmount Decimal Total value added tax in object currency.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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
<Report>
2
     <Rows>
3
          <Row>
4
               <Status
Status

Status of accounts payable transaction

Possible domain values can be found here

>{Integer}</Status>
5
               <Source
Source

Source reference

>
6
                    <Reference
Reference

Source reference

>
7
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
9
                         <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
10
                         <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
11
                         <ItemType
ItemType

Type of item

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Source.Reference.ItemType in your request URI to get this field

>{String}</ItemType>
12
                         <ItemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
14
                    </Reference>
15
                    <Supplier
Supplier

Supplier reference

>
16
                         <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
17
                         <Name
Name

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

>{String}</Name>
18
                         <FirstName
FirstName

Firstname/givenname if the supplier is a person

>{String}</FirstName>
19
                         <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
20
                    </Supplier>
21
                    <SuppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

>{String}</SuppliersInvoiceNumber>
22
                    <BuyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

>{String}</BuyersReferenceNumber>
23
                    <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
24
               </Source>
25
               <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
26
               <PaymentItem
PaymentItem

Payment item reference

>
27
                    <PaymentItemId
PaymentItemId

Item-/line-number of the payment.

>{Integer}</PaymentItemId>
28
                    <Payment
Payment

Payment reference

>
29
                         <PaymentId
PaymentId

Payment identifier

>{Integer}</PaymentId>
30
                         <PaymentLink
PaymentLink

Payment reference

>{String}</PaymentLink>
31
                    </Payment>
32
                    <PaymentItemLink
PaymentItemLink

Payment item reference

>{String}</PaymentItemLink>
33
               </PaymentItem>
34
               <Totals
Totals

Total amounts

>
35
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount

>{Decimal}</TotalAmount>
37
               </Totals>
38
               <TotalsConverted
TotalsConverted

Totals converted to local currency

>
39
                    <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=Rows.Row.TotalsConverted.Currency in your request URI to get this field

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

Total amount in company currency.

>{Decimal}</TotalAmount>
41
               </TotalsConverted>
42
               <Balance
Balance

Total balance

>
43
                    <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=Rows.Row.Balance.Currency in your request URI to get this field

>{String}</Currency>
44
                    <Amount
Amount

Total balance

>{Decimal}</Amount>
45
               </Balance>
46
               <Inspect>
47
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
48
               </Inspect>
49
          </Row>
50
     </Rows>
51
     <Paging
Paging

Detailed paging information for this list.

>
52
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
53
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
54
          <Page
Page

Page index

>{Integer}</Page>
55
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
56
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
57
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
58
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
59
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
60
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
61
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
62
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
63
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
64
     </Paging>
65
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of accounts payable transaction

Possible domain values can be found here

": "{Integer}",
6
                    "source
Source

Source reference

": {
7
                         "reference
Reference

Source reference

": {
8
                              "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
10
                              "objectLink
ObjectLink

API reference to the object

": "{String}",
11
                              "itemId
ItemId

Identifier of the object

": "{Integer}",
12
                              "itemType
ItemType

Type of item

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Source.Reference.ItemType in your request URI to get this field

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

API reference to the item

": "{String}",
14
                              "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
15
                         },
16
                         "supplier
Supplier

Supplier reference

": {
17
                              "supplierId
SupplierId

RamBase supplier identifier

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

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

": "{String}",
19
                              "firstName
FirstName

Firstname/givenname if the supplier is a person

": "{String}",
20
                              "supplierLink
SupplierLink

Supplier reference

": "{String}"
21
                         },
22
                         "suppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

": "{String}",
23
                         "buyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

": "{String}",
24
                         "issueDate
IssueDate

Date when the document was issued.

": "{Date}"
25
                    },
26
                    "dueDate
DueDate

Date the object is due to be paid

": "{Date}",
27
                    "paymentItem
PaymentItem

Payment item reference

": {
28
                         "paymentItemId
PaymentItemId

Item-/line-number of the payment.

": "{Integer}",
29
                         "payment
Payment

Payment reference

": {
30
                              "paymentId
PaymentId

Payment identifier

": "{Integer}",
31
                              "paymentLink
PaymentLink

Payment reference

": "{String}"
32
                         },
33
                         "paymentItemLink
PaymentItemLink

Payment item reference

": "{String}"
34
                    },
35
                    "totals
Totals

Total amounts

": {
36
                         "currency
Currency

Three character code following the ISO 4217 standard

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

Total amount

": "{Decimal}"
38
                    },
39
                    "totalsConverted
TotalsConverted

Totals converted to local currency

": {
40
                         "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=Rows.Row.TotalsConverted.Currency in your request URI to get this field

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

Total amount in company currency.

": "{Decimal}"
42
                    },
43
                    "balance
Balance

Total balance

": {
44
                         "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=Rows.Row.Balance.Currency in your request URI to get this field

": "{String}",
45
                         "amount
Amount

Total balance

": "{Decimal}"
46
                    },
47
                    "inspect": {
48
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
49
                    }
50
               }
51
          ]
52
     }
53
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type