Sales APIs
Sub report to REP/108563. This report shows key figures in local and sales currency for project orders item. It can simply be run for one project order only, by setting filter for this POD id (only the sequense number, like e.g "100012")
Report name | Project order (POD) key figures per item |
Report identifier | 108579 |
HTTP method | GET |
URI | https://api.rambase.net/system/reports/108579/result-set?projectOrderId={projectOrderId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Successful HTTP status code | 200 |
API resource identifier | 5123, version 8 |
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.
projectOrderId Integer, optional |
Project order reference
Minimum: 100000 |
$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.
AccruedPrice Decimal | 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. |
AccruedQuantity Decimal | 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. |
AccruedSale Decimal | 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. |
Category String | The category of this project order item: Material, Hours or Expenses. |
ConvertedAccruedCost Decimal | Accrued cost/{CUR}. |
ConvertedAccruedCostPrice Decimal | Accrued cost price/{CUR}. |
ConvertedAccruedPrice Decimal | Accrued price/{CUR}. |
ConvertedAccruedSale Decimal | Accrued sale/{CUR}. |
ConvertedForecastCost Decimal | Forecast cost/{CUR}. |
ConvertedForecastPrice Decimal | Forecast Price/{CUR}. |
ConvertedForecastSale Decimal | Forecast sale/{CUR}. |
ConvertedInitialEstimatedCost Decimal | Initial estimated cost/{CUR}. |
ConvertedInitialEstimatedCostPrice Decimal | Initial estimated cost price/{CUR}. |
ConvertedInitialEstimatedPrice Decimal | Initial estimated price/{CUR}. |
ConvertedInitialEstimatedSale Decimal | Initial estimated sale/{CUR}. |
ConvertedInvoicedSale Decimal | Invoiced sale/{CUR}. |
ConvertedPendingCost Decimal | Pending cost/{CUR}. |
ConvertedPendingCostPrice Decimal | Pending cost price/{CUR}. |
ConvertedPendingPrice Decimal | Pending price/{CUR}. |
ConvertedPendingSale Decimal | Pending sale/{CUR}. |
ConvertedRemainingEstimatedCostPrice Decimal | Remaining estimated cost price/{CUR}. |
ConvertedRemainingEstimatedPrice Decimal | Remaining estimated price/{CUR}. |
ConvertedRemainingEstimatedSale Decimal | Remaining estimated sale/{CUR}. |
DepartmentId Integer | Department identifier. |
FinanceProjectId Integer | Finance project identifier. |
ForecastPrice Decimal | Forecasted sales price, in sales currency. Is calculated based on remaining, pending and accrued sales price. |
ForecastQuantity Decimal | 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. |
ForecastSale Decimal | Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues. |
InitialEstimatedPrice Decimal | Initial estimated sales price, in sales currency. Will be a copy of the forecasted value at the time the project order is activated. |
InitialEstimatedQuantity Decimal | Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated. |
InitialEstimatedSale Decimal | Initial estimated revenues, in sales currency. Will be a copy of the forecasted value at the time the project order is activated. |
InvoicedSale Decimal | Invoiced revenues, in sales currency. |
MarkupPercent Decimal | By default calculated based on cost price / sale when a PODITEM is created. Can be changed during the project, it will then recalculated prices. |
PendingPrice Decimal | 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. |
PendingQuantity Decimal | 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. |
PendingSale Decimal | 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. |
ProductId Integer | Product identifier. |
ProductName String | Name of the product. |
ProjectOrderId Integer | Project order identifier. |
ProjectOrderItemId Integer | Project order item identifier. |
RemainingEstimatedPrice Decimal | Estimated sales price for the remaining quantity, in sales currency. May be adjusted during the process. |
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. |
RemainingEstimatedSale Decimal | Estimated revenues for the remaining quantity, in sales currency. |
Status String | Status of the project order item. |
Read more about filters and sorting on how to use sortable parameters
AccruedPrice Decimal | 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. |
AccruedQuantity Decimal | 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. |
AccruedSale Decimal | 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. |
Category String | The category of this project order item: Material, Hours or Expenses |
ConvertedAccruedCost Decimal | Accrued cost/{CUR} |
ConvertedAccruedCostPrice Decimal | Accrued cost price/{CUR} |
ConvertedAccruedPrice Decimal | Accrued price/{CUR} |
ConvertedAccruedSale Decimal | Accrued sale/{CUR} |
ConvertedForecastCost Decimal | Forecast cost/{CUR} |
ConvertedForecastPrice Decimal | Forecast Price/{CUR} |
ConvertedForecastSale Decimal | Forecast sale/{CUR} |
ConvertedInitialEstimatedCost Decimal | Initial estimated cost/{CUR} |
ConvertedInitialEstimatedCostPrice Decimal | Initial estimated cost price/{CUR} |
ConvertedInitialEstimatedPrice Decimal | Initial estimated price/{CUR} |
ConvertedInitialEstimatedSale Decimal | Initial estimated sale/{CUR} |
ConvertedInvoicedSale Decimal | Invoiced sale/{CUR} |
ConvertedPendingCost Decimal | Pending cost/{CUR} |
ConvertedPendingCostPrice Decimal | Pending cost price/{CUR} |
ConvertedPendingPrice Decimal | Pending price/{CUR} |
ConvertedPendingSale Decimal | Pending sale/{CUR} |
ConvertedRemainingEstimatedCostPrice Decimal | Remaining estimated cost price/{CUR} |
ConvertedRemainingEstimatedPrice Decimal | Remaining estimated price/{CUR} |
ConvertedRemainingEstimatedSale Decimal | Remaining estimated sale/{CUR} |
DepartmentId Integer | Department identifier |
FinanceProjectId Integer | Finance project identifier |
ForecastPrice Decimal | Forecasted sales price, in sales currency. Is calculated based on remaining, pending and accrued sales price. |
ForecastQuantity Decimal | 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. |
ForecastSale Decimal | Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues. |
InitialEstimatedPrice Decimal | Initial estimated sales price, in sales currency. Will be a copy of the forecasted value at the time the project order is activated. |
InitialEstimatedQuantity Decimal | Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated. |
InitialEstimatedSale Decimal | Initial estimated revenues, in sales currency. Will be a copy of the forecasted value at the time the project order is activated. |
InvoicedSale Decimal | Invoiced revenues, in sales currency. |
MarkupPercent Decimal | By default calculated based on cost price / sale when a PODITEM is created. Can be changed during the project, it will then recalculated prices. |
PendingPrice Decimal | 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. |
PendingQuantity Decimal | 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. |
PendingSale Decimal | 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. |
ProductId Integer | Product identifier |
ProductName String | Name of the product |
ProjectOrderId Integer | Project order identifier |
ProjectOrderItemId Integer | Project order item identifier |
RemainingEstimatedPrice Decimal | Estimated sales price for the remaining quantity, in sales currency. May be adjusted during the process. |
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. |
RemainingEstimatedSale Decimal | Estimated revenues for the remaining quantity, in sales currency. |
Status String | 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.
Status
Status of the project order item
Possible domain values can be found here
>{String}</Status>ProjectOrderItem
Project order item reference
>ProjectOrderItemId
Project order item identifier
>{Integer}</ProjectOrderItemId>ProjectOrder
Project order reference
ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>Name
Name of the project order
>{String}</Name>ProjectOrderLink
Project order reference
>{String}</ProjectOrderLink>ProjectOrderItemLink
Project order item reference
>{String}</ProjectOrderItemLink>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>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>InitialEstimatedQuantity
Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated.
>{Decimal}</InitialEstimatedQuantity>SalesCurrency
Sales currency for project order
>{String}</SalesCurrency>ConvertedInitialEstimatedCost
Initial estimated cost/{CUR}
>{Decimal}</ConvertedInitialEstimatedCost>ConvertedInitialEstimatedSale
Initial estimated sale/{CUR}
>{Decimal}</ConvertedInitialEstimatedSale>RemainingEstimatedQuantity
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}</RemainingEstimatedQuantity>ConvertedRemainingEstimatedCostPrice
Remaining estimated cost price/{CUR}
>{Decimal}</ConvertedRemainingEstimatedCostPrice>PendingQuantity
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}</PendingQuantity>ConvertedPendingCost
Pending cost/{CUR}
>{Decimal}</ConvertedPendingCost>AccruedQuantity
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}</AccruedQuantity>ConvertedAccruedCost
Accrued cost/{CUR}
>{Decimal}</ConvertedAccruedCost>ConvertedForecastCost
Forecast cost/{CUR}
>{Decimal}</ConvertedForecastCost>ForecastSale
Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues.
>{Decimal}</ForecastSale>InvoicedSale
Invoiced revenues, in sales currency.
>{Decimal}</InvoicedSale>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>Status
Status of the project order item
Possible domain values can be found here
": "{String}",ProjectOrderItem
Project order item reference
": {ProjectOrderItemId
Project order item identifier
": "{Integer}",ProjectOrder
Project order reference
ProjectOrderId
Project order identifier
": "{Integer}",Name
Name of the project order
": "{String}",ProjectOrderLink
Project order reference
": "{String}"ProjectOrderItemLink
Project order item reference
": "{String}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{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}",InitialEstimatedQuantity
Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated.
": "{Decimal}",SalesCurrency
Sales currency for project order
": "{String}",ConvertedInitialEstimatedCost
Initial estimated cost/{CUR}
": "{Decimal}",ConvertedInitialEstimatedSale
Initial estimated sale/{CUR}
": "{Decimal}",RemainingEstimatedQuantity
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}",ConvertedRemainingEstimatedCostPrice
Remaining estimated cost price/{CUR}
": "{Decimal}",PendingQuantity
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}",ConvertedPendingCost
Pending cost/{CUR}
": "{Decimal}",AccruedQuantity
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}",ConvertedAccruedCost
Accrued cost/{CUR}
": "{Decimal}",ConvertedForecastCost
Forecast cost/{CUR}
": "{Decimal}",ForecastSale
Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues.
": "{Decimal}",InvoicedSale
Invoiced revenues, in sales 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 |