API

Finance APIs

GET system/reports/103312/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod}&periodView={periodView}&transactionView={transactionView}

Sales Invoices and Credits,

Report name Sales Invoices and Credits,
Report identifier 103312
HTTP method GET
URI https://api.rambase.net/system/reports/103312/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod}&periodView={periodView}&transactionView={transactionView}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 20
Successful HTTP status code 200
API resource identifier 4692, version 25

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.

fromPeriod Integer, optional Report will list records from this period. Format: YYYYMM.

Minimum: 190000,
Maximum: 299999
toPeriod Integer, optional Report will list records to this period. Format: YYYYMM.

Minimum: 190000,
Maximum: 299999
periodView String, optional Quick filter on from and to period. This parameter overrides from and to period if they are specified.
transactionView String, optional Grouping/view of finance reports

Default: CUS
$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 identifier.
Currency String Three character code following the ISO 4217 standard.
CustomerId Integer Customer identifier.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
InvoiceAddressCity String City/town/village.
InvoiceAddressCountry String English name of country.
InvoiceAddressPostalCode String Postalcode/Postcode/ZIP.
IssueDate Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
LocationShortName String Unique abbreviation/short name of the location.
PaymentTerms String Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.
SellersReferenceNumber String Sellers reference number..
Status Integer Status of accounts payable transaction.
TransactionObjectId Integer Identifier of the document.
TransactionObjectType String Type of object.
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 identifier
Currency String Three character code following the ISO 4217 standard
CustomerId Integer Customer identifier
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
InvoiceAddressCity String City/town/village
InvoiceAddressCountry String English name of country.
InvoiceAddressPostalCode String Postalcode/Postcode/ZIP
IssueDate Date Date when the document was issued.
LocationShortName String Unique abbreviation/short name of the location
PaymentTerms String Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.
SellersReferenceNumber String Sellers reference number.
Status Integer Status of accounts payable transaction
TransactionObjectId Integer Identifier of the document
TransactionObjectType String Type of object
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

>{String}</Status>
5
               <Transaction
Transaction

Document reference

>
6
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
8
                    <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
9
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

Filter used in the link to the related document.

>{String}</ObjectLink>
11
               </Transaction>
12
               <Period
Period

Accounting period identifier

>{Integer}</Period>
13
               <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
14
               <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>
15
               <LocationShortName
LocationShortName

Unique abbreviation/short name of the location

>{String}</LocationShortName>
16
               <Customer
Customer

Customer reference

>
17
                    <CustomerId
CustomerId

Customer identifier

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

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

>{String}</Name>
19
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
20
               </Customer>
21
               <InvoiceAddress
InvoiceAddress

Invoice address reference

>
22
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
23
                    <City
City

City/town/village

>{String}</City>
24
                    <Country
Country

English name of country.

>{String}</Country>
25
               </InvoiceAddress>
26
               <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

>{String}</PaymentTerms>
27
               <SellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

>{String}</SellersReferenceNumber>
28
               <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
29
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Payment Currency Rate

>{Decimal}</ExchangeRate>
31
               <VATAmount
VATAmount

Value added tax amount in company currency.

>{Decimal}</VATAmount>
32
               <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

>{Decimal}</TotalAmount>
33
               <ConvertedVATAmount
ConvertedVATAmount

VAT/{SYSCUR}

>{Decimal}</ConvertedVATAmount>
34
               <ConvertedTotalAmount
ConvertedTotalAmount

Amount/{SYSCUR}

>{Decimal}</ConvertedTotalAmount>
35
               <Inspect>
36
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
37
               </Inspect>
38
          </Row>
39
     </Rows>
40
     <Aggregated
Aggregated

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

>
41
          <ConvertedVATAmount
ConvertedVATAmount

VAT/{SYSCUR}

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

>{Decimal}</ConvertedVATAmount>
42
          <ConvertedTotalAmount
ConvertedTotalAmount

Amount/{SYSCUR}

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

>{Decimal}</ConvertedTotalAmount>
43
     </Aggregated>
44
     <ColumnParameters
ColumnParameters

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

>
45
          <ColumnParameter
ColumnParameter

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

>
46
               <Key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

>{String}</Key>
47
               <Value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

>{String}</Value>
48
          </ColumnParameter>
49
     </ColumnParameters>
50
     <Paging
Paging

Detailed paging information for this list.

>
51
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
54
          <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>
55
          <FirstPage
FirstPage

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

>{String}</FirstPage>
56
          <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>
57
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
58
          <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>
59
          <NextPage
NextPage

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

>{String}</NextPage>
60
          <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>
61
          <LastPage
LastPage

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

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

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

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

Status of accounts payable transaction

Possible domain values can be found here

": "{String}",
6
                    "transaction
Transaction

Document reference

": {
7
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

Item-number of the object

": "{Integer}",
10
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

Filter used in the link to the related document.

": "{String}"
12
                    },
13
                    "period
Period

Accounting period identifier

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

Date when the document was issued.

": "{Date}",
15
                    "vATRegistrationNumber
VATRegistrationNumber

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

": "{String}",
16
                    "locationShortName
LocationShortName

Unique abbreviation/short name of the location

": "{String}",
17
                    "customer
Customer

Customer reference

": {
18
                         "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
21
                    },
22
                    "invoiceAddress
InvoiceAddress

Invoice address reference

": {
23
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
24
                         "city
City

City/town/village

": "{String}",
25
                         "country
Country

English name of country.

": "{String}"
26
                    },
27
                    "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

": "{String}",
28
                    "sellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

": "{String}",
29
                    "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
30
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Payment Currency Rate

": "{Decimal}",
32
                    "vATAmount
VATAmount

Value added tax amount in company currency.

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

The total amount in company currency, including VAT.

": "{Decimal}",
34
                    "convertedVATAmount
ConvertedVATAmount

VAT/{SYSCUR}

": "{Decimal}",
35
                    "convertedTotalAmount
ConvertedTotalAmount

Amount/{SYSCUR}

": "{Decimal}",
36
                    "inspect": {
37
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
38
                    }
39
               }
40
          ],
41
          "aggregated
Aggregated

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

": {
42
               "convertedVATAmount
ConvertedVATAmount

VAT/{SYSCUR}

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

": "{Decimal}",
43
               "convertedTotalAmount
ConvertedTotalAmount

Amount/{SYSCUR}

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

": "{Decimal}"
44
          },
45
          "columnParameters
ColumnParameters

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

": [
46
               {
47
                    "key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

": "{String}",
48
                    "value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

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

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