Sales APIs
List of all items belonging to provided credit note.
HTTP method | GET |
URI | https://api.rambase.net/sales/credit-notes/{salesCreditNoteId}/items |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {salesCreditNoteId} |
Sales credit note identifier
Integer, minimum 100000 |
Maximum page size ($top) | 100 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 161, version 13 |
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.
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Currency String | Three character code following the ISO 4217 standard. |
CustomersProductName String | Customers internal name of the product. Retrieved from the product. |
CustomersReferenceNumber String | Customers item reference number. Typically to the customers internal system. |
DepartmentId Integer | Department identifier. |
Discount Decimal | The discount for the item. |
DiscountPercent Decimal | The discount in percent for this item. |
EndCustomerFirstName String | Secondary name of a company or firstname of a person. |
EndCustomerId Integer | Customer identifier. |
EndCustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
FinanceProjectId Integer | Finance project identifier. |
GeneralLedgerAccountId Integer | General ledger account identifier. |
GrossAmount Decimal | Represents the item amount before any discounts etc. is applied. |
GrossPrice Decimal | Represents the price per unit before any discounting is applied. |
ManufacturerId Integer | Manufacturer identifier. |
NetAmount Decimal | Final item amount after deducting all discounts etc. |
NetPrice Decimal | Final price per unit after deducting all discounts etc. |
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 the sales credit note item. |
SalesCreditNoteItemId Integer | Item-/line-number of the credit note. |
Status Integer | Status code of the the credit note item. |
Read more about filters and sorting on how to use sortable parameters
CreatedAt Datetime | Date and time of creation |
Currency String | Three character code following the ISO 4217 standard |
CustomersProductName String | Customers internal name of the product. Retrieved from the product. |
CustomersReferenceNumber String | Customers item reference number. Typically to the customers internal system. |
DepartmentId Integer | Department identifier |
Discount Decimal | The discount for the item. |
DiscountPercent Decimal | The discount in percent for this item. |
EndCustomerFirstName String | Secondary name of a company or firstname of a person |
EndCustomerId Integer | Customer identifier |
EndCustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
FinanceProjectId Integer | Finance project identifier |
GeneralLedgerAccountId Integer | General ledger account identifier |
GrossAmount Decimal | Represents the item amount before any discounts etc. is applied. |
GrossPrice Decimal | Represents the price per unit before any discounting is applied. |
ManufacturerId Integer | Manufacturer identifier |
NetAmount Decimal | Final item amount after deducting all discounts etc. |
NetPrice Decimal | Final price per unit after deducting all discounts etc. |
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 the sales credit note item |
SalesCreditNoteItemId Integer | Item-/line-number of the credit note |
Status Integer | Status code of the the credit note item |
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.
SalesCreditNoteItemId
Item-/line-number of the credit note
>{Integer}</SalesCreditNoteItemId>Status
Status code of the the credit note item
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
>{String}</CustomersProductName>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>DiscountPercent
The discount in percent for this item.
>{Decimal}</DiscountPercent>Quantity
Quantity of the sales credit note item
>{Decimal}</Quantity>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Discount
The discount for the item.
>{Decimal}</Discount>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Represents the item amount before any discounts etc. is applied.
>{Decimal}</GrossAmount>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>SalesCreditNoteItemLink
Sales credit note Item reference
>{String}</SalesCreditNoteItemLink>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>SalesCreditNoteItemId
Item-/line-number of the credit note
": "{Integer}",Status
Status code of the the credit note item
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
": "{String}",CustomersProductName
Customers 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}",DiscountPercent
The discount in percent for this item.
": "{Decimal}",Quantity
Quantity of the sales credit note item
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",Discount
The discount for the item.
": "{Decimal}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Represents the item amount before any discounts etc. is applied.
": "{Decimal}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ManufacturerId
Manufacturer identifier
": "{Integer}",ManufacturerLink
Manufacturer reference
": "{String}"SalesCreditNoteItemLink
Sales 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 102738 HTTP 404 | Price list not found |
Error 100055 HTTP 403 | You have only admittance to your own objects |