Procurement APIs
List of all supplier credit note items for a specific identifier
HTTP method | GET |
URI | https://api.rambase.net/procurement/credit-notes/{supplierCreditNoteId}/items |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {supplierCreditNoteId} |
Supplier credit note identifier
Integer, minimum 100000 |
Maximum page size ($top) | 80 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 4300, version 1 |
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" |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
$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.
ApprovalNotification() Named filter | Supplier credit note items with notifications of category A (approvals) |
ApprovedItemsWaitReg() Named filter | Supplier credit note items which are approved and waiting to be registered. |
InfoNotification() Named filter | Supplier credit note items with notifications of category I (Information) |
MyApprovals() Named filter | Supplier credit note items with my pending approval |
MyItems() Named filter | Supplier credit notes current user is assigned to |
WaitingForGoods() Named filter | Supplier credit notes waiting for goods |
WaitingSendToApprov() Named filter | Supplier credit notes waiting to be sent for approval |
WaitingToBeApproved() Named filter | Supplier credit notes waiting to be approved |
ContainingNotificationMessage String | Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language. |
ContainingNotificationTypeId Integer | Notification type identifier. |
Note String | Additional information regarding the item (free text). Might be visible to customers/suppliers. |
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. |
ProductType String | Type of product. |
Quantity Decimal | Quantity of supplier credit note item. |
Status Integer | Status of the purchase credit note item. |
SupplierCreditNoteItemId Integer | Item-/linenumber of supplier credit note. |
SuppliersProductName String | Suppliers internal name of the product. Retrieved from the product. |
SuppliersReferenceNumber String | Suppliers/sellers item reference number. Typically to an external system. |
Read more about filters and sorting on how to use sortable parameters
ContainingNotificationMessage String | Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language. |
ContainingNotificationTypeId Integer | Notification type identifier |
Note String | Additional information regarding the item (free text). Might be visible to customers/suppliers. |
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 |
ProductType String | Type of product |
Quantity Decimal | Quantity of supplier credit note item |
Status Integer | Status of the purchase credit note item |
SupplierCreditNoteItemId Integer | Item-/linenumber of supplier credit note |
SuppliersProductName String | Suppliers internal name of the product. Retrieved from the product. |
SuppliersReferenceNumber String | Suppliers/sellers item reference number. Typically to an external system. |
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.
SupplierCreditNoteItemId
Item-/linenumber of supplier credit note
>{Integer}</SupplierCreditNoteItemId>Status
Status of the purchase credit note item
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
>{Integer}</LineNumber>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
>{String}</SuppliersProductName>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
>{String}</Note>VATPercent
Value added tax percent
>{Decimal}</VATPercent>Quantity
Quantity of supplier credit note item
>{Decimal}</Quantity>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
Material unit reference
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Department
The department related to the item. One of the system/fixed account dimensions.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>Asset
The asset related to the item. One of the system/fixed account dimensions.
>AssetId
Asset identifier
>{Integer}</AssetId>AssetLink
Asset reference
>{String}</AssetLink>SupplierCreditNoteItemLink
Supplier credit note Item reference
>{String}</SupplierCreditNoteItemLink>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>SupplierCreditNoteItemId
Item-/linenumber of supplier credit note
": "{Integer}",Status
Status of the purchase credit note item
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
": "{Integer}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
": "{String}",SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
": "{String}",VATPercent
Value added tax percent
": "{Decimal}",Quantity
Quantity of supplier credit note item
": "{Decimal}",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
Material unit reference
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
": {VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"Department
The department related to the item. One of the system/fixed account dimensions.
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"Asset
The asset related to the item. One of the system/fixed account dimensions.
": {AssetId
Asset identifier
": "{Integer}",AssetLink
Asset reference
": "{String}"SupplierCreditNoteItemLink
Supplier credit note Item reference
": "{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 |