Procurement APIs
List of all supplier billing items
HTTP method | GET |
URI | https://api.rambase.net/procurement/billing-items |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 200 |
Successful HTTP status code | 200 |
API resource identifier | 3725, version 16 |
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.
$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. |
AssetId Integer | Asset identifier. |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
DepartmentId Integer | Department identifier. |
FinanceProjectId Integer | Finance project identifier. |
GeneralLedgerAccountId Integer | General ledger account identifier. |
ItemId Integer | Item-number of the object. |
NetPrice Decimal | Final price per unit after deducting all discounts etc. |
ObjectId Integer | Identifier of the object. |
ObjectType String | Type of object. |
ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
ProductId Integer | Product identifier. |
ProductName String | Name of the product. |
ProductRevision String | Revision number. |
ProductType String | Type of product. |
ProjectOrderId Integer | Project order identifier. |
ProjectOrderItemId Integer | Project order item identifier. |
Quantity Decimal | Quantity of billing item. |
RegistrationDate Date | Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Status Integer | Status of billing item. |
SupplierId Integer | RamBase supplier identifier. |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
SupplierReferenceNumber String | Suppliers/sellers reference number. Typically to an external system. |
VATCode String | Code that determines VAT rules used for VAT calculations. |
Read more about filters and sorting on how to use sortable parameters
AccountingPeriod Integer | Accounting period |
AssetId Integer | Asset identifier |
CreatedAt Datetime | Date and time of creation |
DepartmentId Integer | Department identifier |
FinanceProjectId Integer | Finance project identifier |
GeneralLedgerAccountId Integer | General ledger account identifier |
ItemId Integer | Item-number of the object |
NetPrice Decimal | Final price per unit after deducting all discounts etc. |
ObjectId Integer | Identifier of the object |
ObjectType String | Type of object |
ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
ProductId Integer | Product identifier |
ProductName String | Name of the product |
ProductRevision String | Revision number |
ProductType String | Type of product |
ProjectOrderId Integer | Project order identifier |
ProjectOrderItemId Integer | Project order item identifier |
Quantity Decimal | Quantity of billing item |
RegistrationDate Date | Date of registration |
Status Integer | Status of billing item |
SupplierId Integer | RamBase supplier identifier |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person) |
SupplierReferenceNumber String | Suppliers/sellers reference number. Typically to an external system. |
VATCode String | Code that determines VAT rules used for VAT calculations. |
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.
ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>Status
Status of billing item
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Quantity
Quantity of billing item
>{Decimal}</Quantity>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>Revision
Revision number
>{String}</Revision>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>RegistrationDate
Date of registration
>{Date}</RegistrationDate>SupplierReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
>{String}</SupplierReferenceNumber>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>AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ItemLink
API reference to the item
>{String}</ItemLink>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>ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",Status
Status of billing item
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Quantity
Quantity of billing item
": "{Decimal}",ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"Revision
Revision number
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",RegistrationDate
Date of registration
": "{Date}",SupplierReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
": "{String}",SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{String}"ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100027 HTTP 400 | Missing mandatory parameter {0} |
Error 101420 HTTP 404 | Setting definition not found |