Finance APIs
Rersource for RPD/100207
| Report name | Purchase, By Document. |
| Report identifier | 100207 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/100207/result-set?fromPeriod={fromPeriod}&toPeriod={toPeriod}&periodView={periodView} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 20 |
| Successful HTTP status code | 200 |
| API resource identifier | 4702, version 14 |
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.
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. |
| $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. |
| DepartmentId Integer | Department identifier. |
| RegistrationDate Date | Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ShippingAddressCountryCode String | Country code of shipment destination. |
| SupplierId Integer | RamBase supplier identifier. |
| VATType String | Type of value added tax. |
Read more about filters and sorting on how to use sortable parameters
| AccountingPeriod Integer | Accounting period identifier |
| RegistrationDate Date | Date when the document was issued. |
| SupplierId Integer | RamBase supplier identifier |
| VATType String | Type of value added tax |
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.
Transaction
Document reference
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ItemId
Item-number of the object
>{Integer}</ItemId>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
Filter used in the link to the related document.
>{String}</ObjectLink>Period
Accounting period identifier
>{Integer}</Period>RegistrationDate
Date when the document was issued.
>{Date}</RegistrationDate>Supplier
Supplier reference
>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier reference
>{String}</SupplierLink>VATType
Type of value added tax
>{String}</VATType>GLAccount
General ledger account reference
>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>Name
Name of general ledger account
>{String}</Name>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Department
Department reference. One of the system/fixed account dimensions.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>Name
Name of department
>{String}</Name>DepartmentLink
Finance department reference
>{String}</DepartmentLink>ShippingAddress
Shipping address reference
>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
>{String}</VATRegistrationNumber>ConvertedNetAmount
Total net amount in company currency.
>{Decimal}</ConvertedNetAmount>ConvertedVATAmount
Value added tax amount in company currency.
>{Decimal}</ConvertedVATAmount>ConvertedTotalAmount
Total gross amount in company currency.
>{Decimal}</ConvertedTotalAmount>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Transaction
Document reference
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ItemId
Item-number of the object
": "{Integer}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
Filter used in the link to the related document.
": "{String}"Period
Accounting period identifier
": "{Integer}",RegistrationDate
Date when the document was issued.
": "{Date}",Supplier
Supplier reference
": {SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"VATType
Type of value added tax
": "{String}",GLAccount
General ledger account reference
": {AccountNumber
The account number of the general ledger account
": "{String}",Name
Name of general ledger account
": "{String}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"Department
Department reference. One of the system/fixed account dimensions.
": {DepartmentId
Department identifier
": "{Integer}",Name
Name of department
": "{String}",DepartmentLink
Finance department reference
": "{String}"ShippingAddress
Shipping address reference
": {CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}"VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
": "{String}",ConvertedNetAmount
Total net amount in company currency.
": "{Decimal}",ConvertedVATAmount
Value added tax amount in company currency.
": "{Decimal}",ConvertedTotalAmount
Total gross amount in company currency.
": "{Decimal}",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 |