Finance APIs

GET system/reports/115368/result-set

Overview over payments and whitelist check

Report name	Overview over payments and whitelist check
Report identifier	115368
HTTP method	GET
URI	https://api.rambase.net/system/reports/115368/result-set
Supported formats	Xml, Html, Json (ex. $format=json)
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	6454, 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:

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.

$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.

PaymentId Integer	Payment identifier.
PaymentTotalsCurrency String	Three character code following the ISO 4217 standard.
PaymentTotalsTotalAmount Decimal	Total amount.
PaymentTranslatedDescription String	Payment note.
SourceReferenceId Integer	Identifier of the object.
SupplierBankAccountId Integer	Supplier bank account identifier.
SupplierBankAccountName String	Name of bank account.
SupplierBankAccountNumber String	Account number used to identify the bank account.
SupplierCountryCode String	Two-character code (ISO 3166) identifying the country.
SupplierCountryName String	English name of country.
SupplierFirstName String	Firstname/givenname if the supplier is a person.
SupplierId Integer	RamBase supplier identifier.
SupplierName String	Name of supplier (name of company or surname/familyname/lastname of a person).
SupplierVATRegistrationNumber 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

PaymentId Integer	Payment identifier
PaymentTotalsCurrency String	Three character code following the ISO 4217 standard
PaymentTotalsTotalAmount Decimal	Total amount
PaymentTranslatedDescription String	Payment note
SourceReferenceId Integer	Identifier of the object
SupplierBankAccountId Integer	Supplier bank account identifier
SupplierBankAccountName String	Name of bank account
SupplierBankAccountNumber String	Account number used to identify the bank account
SupplierCountryCode String	Two-character code (ISO 3166) identifying the country.
SupplierCountryName String	English name of country.
SupplierFirstName String	Firstname/givenname if the supplier is a person
SupplierId Integer	RamBase supplier identifier
SupplierName String	Name of supplier (name of company or surname/familyname/lastname of a person)
SupplierVATRegistrationNumber 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:

                                        <Report>
                                    

                                             <Rows>
                                    

                                                  <Row>
                                    

<ValidatedAt

ValidatedAt

Date and time for when the payment was validated

>{Datetime}</ValidatedAt>

<Payment

Payment

Payment reference

<PaymentId

PaymentId

Payment identifier

>{Integer}</PaymentId>

<PaymentLink

PaymentLink

Payment reference

>{String}</PaymentLink>

<TranslatedDescription

TranslatedDescription

Payment note

>{String}</TranslatedDescription>

<Totals

Totals

Total amounts

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<TotalAmount

TotalAmount

Total amount

>{Decimal}</TotalAmount>

                                                            </Totals>
                                    

                                                       </Payment>
                                    

<Source

Source

Source reference

<Reference

Reference

Document reference

<ObjectId

ObjectId

Identifier of the object

>{Integer}</ObjectId>

<ObjectType

ObjectType

Type of object

>{String}</ObjectType>

<ObjectLink

ObjectLink

API reference to the object

>{String}</ObjectLink>

<RamBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>

                                                            </Reference>
                                    

<Supplier

Supplier

Supplier reference

<SupplierId

SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>

<Name

Name

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

>{String}</Name>

<FirstName

FirstName

Firstname/givenname if the supplier is a person

>{String}</FirstName>

<VATRegistrationNumber

VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

>{String}</VATRegistrationNumber>

<Country

Country

Supplier country reference

<CountryCode

CountryCode

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

>{String}</CountryCode>

<Name

Name

English name of country.

>{String}</Name>

                                                                 </Country>
                                    

<SupplierLink

SupplierLink

Supplier reference

>{String}</SupplierLink>

                                                            </Supplier>
                                    

<SupplierBankAccount

SupplierBankAccount

Bank account reference

<SupplierBankAccountId

SupplierBankAccountId

Supplier bank account identifier

>{Integer}</SupplierBankAccountId>

<Name

Name

Name of bank account

>{String}</Name>

<AccountNumber

AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>

<SupplierBankAccountLink

SupplierBankAccountLink

Supplier bank account reference

>{String}</SupplierBankAccountLink>

                                                            </SupplierBankAccount>
                                    

                                                       </Source>
                                    

<ValidationResult

ValidationResult

The result of validation of the VAT registration number and bank account on the whitelist of VAT taxpayers

>{String}</ValidationResult>

<IsManuallyValidated

IsManuallyValidated

Show if the supplier was validated trough the manual operation

>{Boolean}</IsManuallyValidated>

<ValidatedBy

ValidatedBy

Shows who triggered the validation if it was manually done.

<UserId

UserId

User identifier

>{Integer}</UserId>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<Name

Name

Name of the user

>{String}</Name>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                       </ValidatedBy>
                                    

                                                       <Inspect>
                                    

<TargetApplication

TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>

                                                       </Inspect>
                                    

                                                  </Row>
                                    

                                             </Rows>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

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

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<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>

<FirstPage

FirstPage

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

>{String}</FirstPage>

<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>

<PreviousPage

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

>{String}</PreviousPage>

<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>

<NextPage

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

>{String}</NextPage>

<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>

<LastPage

LastPage

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

>{String}</LastPage>

<Size

Size

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

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Report>
                                    

{

                                             "report": {
                                    

                                                  "rows": [
                                    

{

"validatedAt

ValidatedAt

Date and time for when the payment was validated

": "{Datetime}",

"payment

Payment

Payment reference

": {

"paymentId

PaymentId

Payment identifier

": "{Integer}",

"paymentLink

PaymentLink

Payment reference

": "{String}",

"translatedDescription

TranslatedDescription

Payment note

": "{String}",

"totals

Totals

Total amounts

": {

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"totalAmount

TotalAmount

Total amount

": "{Decimal}"

}

},

"source

Source

Source reference

": {

"reference

Reference

Document reference

": {

"objectId

ObjectId

Identifier of the object

": "{Integer}",

"objectType

ObjectType

Type of object

": "{String}",

"objectLink

ObjectLink

API reference to the object

": "{String}",

"ramBaseKey

RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"

},

"supplier

Supplier

Supplier reference

": {

"supplierId

SupplierId

RamBase supplier identifier

": "{Integer}",

"name

Name

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

": "{String}",

"firstName

FirstName

Firstname/givenname if the supplier is a person

": "{String}",

"vATRegistrationNumber

VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

": "{String}",

"country

Country

Supplier country reference

": {

"countryCode

CountryCode

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

": "{String}",

"name

Name

English name of country.

": "{String}"

},

"supplierLink

SupplierLink

Supplier reference

": "{String}"

},

"supplierBankAccount

SupplierBankAccount

Bank account reference

": {

"supplierBankAccountId

SupplierBankAccountId

Supplier bank account identifier

": "{Integer}",

"name

Name

Name of bank account

": "{String}",

"accountNumber

AccountNumber

Account number used to identify the bank account

": "{String}",

"supplierBankAccountLink

SupplierBankAccountLink

Supplier bank account reference

": "{String}"

}

},

"validationResult

ValidationResult

The result of validation of the VAT registration number and bank account on the whitelist of VAT taxpayers

": "{String}",

"isManuallyValidated

IsManuallyValidated

Show if the supplier was validated trough the manual operation

": "{Boolean}",

"validatedBy

ValidatedBy

Shows who triggered the validation if it was manually done.

": {

"userId

UserId

User identifier

": "{Integer}",

"firstName

FirstName

First name of the user

": "{String}",

"name

Name

Name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

                                                            "inspect": {
                                    

"targetApplication

TargetApplication

Application reference when inspecting a line in a report.

": "{String}"

}

}

]

}

}

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