Sales APIs
List of project order items
| HTTP method | GET |
| URI | https://api.rambase.net/sales/project-orders/{projectOrderId}/items?onlyBillableSales={onlyBillableSales}&latestIncurredCostDate={latestIncurredCostDate} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {projectOrderId} |
Project order identifier
Integer, minimum 100000 |
| Maximum page size ($top) | 80 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 4102, version 45 |
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.
| onlyBillableSales Boolean, optional | Determines whether to list all items (false) or only those items which have a billing basis (true). |
| latestIncurredCostDate Date, optional | Only show billing basis based on revenues which has incurred before this date or earlier |
| $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.
| ActiveItems() Named filter | Active project order items (status 4) |
| Expenses() Named filter | Project order items with category "Expenses" |
| Hours() Named filter | Project order items with category "Hours" |
| Material() Named filter | Project order items with category "Material" |
| New() Named filter | Project order items which are not registered yet (status 1 and 2) |
| PausedItems() Named filter | Paused project order items (status 5) |
| ProcessedItems() Named filter | Processed project order items (status 9) |
| UnreadNotification() Named filter | Project order items with unread notification |
| Category String | The category of this project order item: Material, Hours or Expenses. |
| 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. |
| 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). |
| HasManuallyAccruedHandling Boolean | (Discontinued) Only available items of category "Expenses". Set to "true" in cases where RamBase cannot know accrued cost, -e.g for salary expences in an external system etc. Accrued cost and price can then be set manually. |
| IsBasedOnExpenseLog Boolean | This is to decide if a project order item of category 'Expenses' should have its cost calculated based on expense logs (EXL), or purhase orders (SPO/SOA) and supplier invoices (SIN/SCN). IsBasedOnExpenseLog=”True” means that EXL will be basis for cost/sale, and “Fault” means that SPO/SOA/SIN/SCN will be basis. |
| IsDependantOnSerialNumbers Boolean | Determines whether or not it's required to provide valid serial numbers for project order item during its process of goods consumption confirmation. |
| LineNumber Integer | Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports 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. |
| ProjectOrderItemId Integer | Project order item identifier. |
| RemainingEstimatedQuantity Decimal | Remaining estimated quantity is the expected remaining quantity to deliver. Will e.g be reduced when work hours are logged, but can be manually adjusted anytime. |
| RequestedDeliveryDate Date | The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Status Integer | Status of the project order item. |
Read more about filters and sorting on how to use sortable parameters
| Category String | The category of this project order item: Material, Hours or Expenses |
| 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 |
| 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) |
| HasManuallyAccruedHandling Boolean | (Discontinued) Only available items of category "Expenses". Set to "true" in cases where RamBase cannot know accrued cost, -e.g for salary expences in an external system etc. Accrued cost and price can then be set manually |
| IsBasedOnExpenseLog Boolean | This is to decide if a project order item of category 'Expenses' should have its cost calculated based on expense logs (EXL), or purhase orders (SPO/SOA) and supplier invoices (SIN/SCN). IsBasedOnExpenseLog=”True” means that EXL will be basis for cost/sale, and “Fault” means that SPO/SOA/SIN/SCN will be basis. |
| IsDependantOnSerialNumbers Boolean | Determines whether or not it's required to provide valid serial numbers for project order item during its process of goods consumption confirmation |
| LineNumber Integer | Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports 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 |
| ProjectOrderItemId Integer | Project order item identifier |
| RemainingEstimatedQuantity Decimal | Remaining estimated quantity is the expected remaining quantity to deliver. Will e.g be reduced when work hours are logged, but can be manually adjusted anytime. |
| RequestedDeliveryDate Date | The delivery date as requested by the customer. |
| Status Integer | Status of the project order 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.
ProjectOrderItemId
Project order item identifier
>{Integer}</ProjectOrderItemId>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
>{Integer}</LineNumber>Status
Status of the project order item
Possible domain values can be found here
>{Integer}</Status>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Category
The category of this project order item: Material, Hours or Expenses
Possible domain values can be found here
>{String}</Category>IsBasedOnExpenseLog
This is to decide if a project order item of category 'Expenses' should have its cost calculated based on expense logs (EXL), or purhase orders (SPO/SOA) and supplier invoices (SIN/SCN).
IsBasedOnExpenseLog=”True” means that EXL will be basis for cost/sale, and “Fault” means that SPO/SOA/SIN/SCN will be basis.
IsDependantOnSerialNumbers
Determines whether or not it's required to provide valid serial numbers for project order item during its process of goods consumption confirmation
>{Boolean}</IsDependantOnSerialNumbers>AssignmentStatus
Status of the internal sales order for "Material for project order' which is used for getting assignments of material for a project order item.
Possible domain values can be found here
>{Integer}</AssignmentStatus>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>MarkupPercent
A copy of markup percent at the time the project order was activated.
>{Decimal}</MarkupPercent>Quantity
Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated.
>{Decimal}</Quantity>Price
Initial estimated sales price, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.
>{Decimal}</Price>Amount
Initial estimated revenues, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.
>{Decimal}</Amount>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>Price
Initial estimated cost pr unit, in local currency. Will not be updated after the project order has been activated.
>{Decimal}</Price>Amount
Initial estimated cost, in local currency. Will not be updated after the project order has been activated.
>{Decimal}</Amount>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>MarkupPercent
By default calculated based on cost price / sale when a PODITEM is created. Can be changed during the project, it will then recalculated prices.
>{Decimal}</MarkupPercent>Quantity
Remaining estimated quantity is the expected remaining quantity to deliver. Will e.g be reduced when work hours are logged, but can be manually adjusted anytime.
>{Decimal}</Quantity>Price
Estimated sales price for the remaining quantity, in sales currency. May be adjusted during the process.
>{Decimal}</Price>Amount
Estimated revenues for the remaining quantity, in sales currency.
>{Decimal}</Amount>Quantity
Pending quantity. Quantity is to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
>{Decimal}</Quantity>Price
Pending sales price, in sales currency. Revenues are to be understood as pending e.g when hours are logged, but not approved by manager (status 3), -or when the internal sales order for "Material to project order" has been created, but material has not been confirmed as consumed yet.
>{Decimal}</Price>Amount
Pending revenues, in sales currency. Revenues are to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
>{Decimal}</Amount>Quantity
Accrued quantity. Quantity that has been accrued is to be understood as e.g logged hours that are approved, or material has been confirmed as consumed.
>{Decimal}</Quantity>Price
Accrued sales price, in sales currency. Revenues are to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.
>{Decimal}</Price>Amount
Accrued revenues, in sales currency. Revenues are to be understood as accrued e.g if logged hours have been approved or when material has been confirmed as consumed.
>{Decimal}</Amount>Quantity
Forecasted quantity is an accumulated value of RemainingQty + PendingQty + AccruedQty. It's the total quantity one expect to deliver based on the situation at the moment.
>{Decimal}</Quantity>Price
Forecasted sales price, in sales currency. Is calculated based on remaining, pending and accrued sales price.
>{Decimal}</Price>Amount
Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues.
>{Decimal}</Amount>Amount
Invoiced revenues, in sales currency.
>{Decimal}</Amount>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>ProjectOrderItemId
Project order item identifier
": "{Integer}",LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
": "{Integer}",Status
Status of the project order item
Possible domain values can be found here
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Category
The category of this project order item: Material, Hours or Expenses
Possible domain values can be found here
": "{String}",IsBasedOnExpenseLog
This is to decide if a project order item of category 'Expenses' should have its cost calculated based on expense logs (EXL), or purhase orders (SPO/SOA) and supplier invoices (SIN/SCN).
IsBasedOnExpenseLog=”True” means that EXL will be basis for cost/sale, and “Fault” means that SPO/SOA/SIN/SCN will be basis.
IsDependantOnSerialNumbers
Determines whether or not it's required to provide valid serial numbers for project order item during its process of goods consumption confirmation
": "{Boolean}",AssignmentStatus
Status of the internal sales order for "Material for project order' which is used for getting assignments of material for a project order item.
Possible domain values can be found here
": "{Integer}",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}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",MarkupPercent
A copy of markup percent at the time the project order was activated.
": "{Decimal}",Quantity
Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated.
": "{Decimal}",Price
Initial estimated sales price, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.
": "{Decimal}",Amount
Initial estimated revenues, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",Price
Initial estimated cost pr unit, in local currency. Will not be updated after the project order has been activated.
": "{Decimal}",Amount
Initial estimated cost, in local currency. Will not be updated after the project order has been activated.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",MarkupPercent
By default calculated based on cost price / sale when a PODITEM is created. Can be changed during the project, it will then recalculated prices.
": "{Decimal}",Quantity
Remaining estimated quantity is the expected remaining quantity to deliver. Will e.g be reduced when work hours are logged, but can be manually adjusted anytime.
": "{Decimal}",Price
Estimated sales price for the remaining quantity, in sales currency. May be adjusted during the process.
": "{Decimal}",Amount
Estimated revenues for the remaining quantity, in sales currency.
": "{Decimal}"Quantity
Pending quantity. Quantity is to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
": "{Decimal}",Price
Pending sales price, in sales currency. Revenues are to be understood as pending e.g when hours are logged, but not approved by manager (status 3), -or when the internal sales order for "Material to project order" has been created, but material has not been confirmed as consumed yet.
": "{Decimal}",Amount
Pending revenues, in sales currency. Revenues are to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
": "{Decimal}"Quantity
Accrued quantity. Quantity that has been accrued is to be understood as e.g logged hours that are approved, or material has been confirmed as consumed.
": "{Decimal}",Price
Accrued sales price, in sales currency. Revenues are to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.
": "{Decimal}",Amount
Accrued revenues, in sales currency. Revenues are to be understood as accrued e.g if logged hours have been approved or when material has been confirmed as consumed.
": "{Decimal}"Quantity
Forecasted quantity is an accumulated value of RemainingQty + PendingQty + AccruedQty. It's the total quantity one expect to deliver based on the situation at the moment.
": "{Decimal}",Price
Forecasted sales price, in sales currency. Is calculated based on remaining, pending and accrued sales price.
": "{Decimal}",Amount
Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues.
": "{Decimal}"Amount
Invoiced revenues, in sales currency.
": "{Decimal}"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 102120 HTTP 404 | Delivery project not found |
| Error 100104 HTTP 404 | Address not found |
| Error 100001 HTTP 404 | Address not found |