Sales APIs
List of production delivery snapshots related to specific sales delivery project
| HTTP method | GET |
| URI | https://api.rambase.net/sales/delivery-projects/{salesDeliveryProjectId}/production-delivery-snapshots |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesDeliveryProjectId} |
Sales delivery project identifier
Integer, minimum 100000 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 2266, version 18 |
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.
| $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.
| Date Date | Date of production delivery snapshot. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| IsLastDayOfAccountingPeriod Boolean | This date is last day of a accounting period. |
| Milestone String | User defined milestone for production delivery snapshot. |
| Note String | Note for the production delivery snapshot. |
| ProductionDeliverySnapshotId Integer | Production delivery snapshot identifier. |
| TotalAccruedCost Decimal | Total accrued cost of the delivery project. |
| TotalAccruedHours Decimal | Total accrued hours for the delivery project. |
| TotalAccruedIncome Decimal | Salesbacklog multiplied with percent completed. If percent completed is not specified for the production delivery snapshot, the accrued income is aggregated from each of the work breakdown structure elements. The accrued income will be the same as invoiced amount by the end of the delivery project. |
| TotalAdvanceInvoicedAmount Decimal | Total advance invoice amount for the delivery project. |
| TotalInvoicedAmount Decimal | Total invoiced amount of the delivery project. |
| TotalPlannedCost Decimal | Total planned cost of the delivery project. |
| TotalPlannedHours Decimal | Total accrued hours for the delivery project. |
| TotalSalesBacklog Decimal | Total sales backlog of the delivery project. |
Read more about filters and sorting on how to use sortable parameters
| Date Date | Date of production delivery snapshot |
| IsLastDayOfAccountingPeriod Boolean | This date is last day of a accounting period. |
| Milestone String | User defined milestone for production delivery snapshot |
| Note String | Note for the production delivery snapshot |
| ProductionDeliverySnapshotId Integer | Production delivery snapshot identifier |
| TotalAccruedCost Decimal | Total accrued cost of the delivery project |
| TotalAccruedHours Decimal | Total accrued hours for the delivery project |
| TotalAccruedIncome Decimal | Salesbacklog multiplied with percent completed. If percent completed is not specified for the production delivery snapshot, the accrued income is aggregated from each of the work breakdown structure elements. The accrued income will be the same as invoiced amount by the end of the delivery project. |
| TotalAdvanceInvoicedAmount Decimal | Total advance invoice amount for the delivery project |
| TotalInvoicedAmount Decimal | Total invoiced amount of the delivery project |
| TotalPlannedCost Decimal | Total planned cost of the delivery project |
| TotalPlannedHours Decimal | Total accrued hours for the delivery project |
| TotalSalesBacklog Decimal | Total sales backlog of the delivery project |
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.
ProductionDeliverySnapshotId
Production delivery snapshot identifier
>{Integer}</ProductionDeliverySnapshotId>Date
Date of production delivery snapshot
>{Date}</Date>Milestone
User defined milestone for production delivery snapshot
>{String}</Milestone>Note
Note for the production delivery snapshot
>{String}</Note>PercentCompleted
User defined percent completed of the project
>{Decimal}</PercentCompleted>IsLastDayOfAccountingPeriod
This date is last day of a accounting period.
>{Boolean}</IsLastDayOfAccountingPeriod>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>SalesBacklog
Total sales backlog of the delivery project
>{Decimal}</SalesBacklog>AccruedIncome
Salesbacklog multiplied with percent completed. If percent completed is not specified for the production delivery snapshot, the accrued income is aggregated from each of the work breakdown structure elements. The accrued income will be the same as invoiced amount by the end of the delivery project.
>{Decimal}</AccruedIncome>InvoicedAmount
Total invoiced amount of the delivery project
>{Decimal}</InvoicedAmount>AdvanceInvoicedAmount
Total advance invoice amount for the delivery project
>{Decimal}</AdvanceInvoicedAmount>SalesValue
Totals.SalesBacklog + Totals.InvoicedAmount
>{Decimal}</SalesValue>Hours
Total accrued hours for the delivery project
>{Decimal}</Hours>MaterialCost
SUMPLANNEDMATERIALCOST
>{Decimal}</MaterialCost>FixedAdditionalCost
SUMPLANNEDADDEDFIXEDCOST
>{Decimal}</FixedAdditionalCost>VariableAdditionalCost
SUMPLANNEDADDEDVARCOST
>{Decimal}</VariableAdditionalCost>FixedOperationCost
SUMPLANNEDOPERATIONFIXEDCOST
>{Decimal}</FixedOperationCost>VariableOperationCost
SUMPLANNEDOPERATIONVARCOST
>{Decimal}</VariableOperationCost>TotalCost
Total planned cost of the delivery project
>{Decimal}</TotalCost>Hours
Total accrued hours for the delivery project
>{Decimal}</Hours>MaterialCost
SUMACCRUEDMATERIALCOST
>{Decimal}</MaterialCost>FixedAdditionalCost
SUMACCRUEDADDEDFIXEDCOST
>{Decimal}</FixedAdditionalCost>VariableAdditionalCost
SUMACCRUEDADDEDVARCOST
>{Decimal}</VariableAdditionalCost>FixedOperationCost
SUMACCRUEDOPERATIONFIXEDCOST
>{Decimal}</FixedOperationCost>VariableOperationCost
SUMACCRUEDOPERATIONVARCOST
>{Decimal}</VariableOperationCost>TotalCost
Total accrued cost of the delivery project
>{Decimal}</TotalCost>CostOfGoods
Field from finance linked to PRO by PRO.PRJNO.
'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.
SalaryCost
Field from finance linked to PRO by PRO.PRJNO.
Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.
OtherCost
Field from finance linked to PRO by PRO.PRJNO.
>{Decimal}</OtherCost>Income
Field from finance linked to PRO by PRO.PRJNO.
User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.
StockValue
Inventory value for a delivery project is sum of all inventory on the related finance project. Use SVR with filter on the given project to find the correct value.
>{Decimal}</StockValue>Income
InvoicedAmount + OtherIncome
>{Decimal}</Income>Cost
Accrued.ToyalCost + OtherCostOfGoods + Wages + OtherExpences
>{Decimal}</Cost>Profit
TotalIncome - TotalCost
>{Decimal}</Profit>DeliveryProjectId
Sales delivery project identifier
>{Integer}</DeliveryProjectId>Name
Name of sales delivery
>{String}</Name>DeliveryProjectLink
Sales delivery project reference
>{String}</DeliveryProjectLink>ProductionDeliverySnapshotLink
Production delivery snapshot reference
>{String}</ProductionDeliverySnapshotLink>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>ProductionDeliverySnapshotId
Production delivery snapshot identifier
": "{Integer}",Date
Date of production delivery snapshot
": "{Date}",Milestone
User defined milestone for production delivery snapshot
": "{String}",Note
Note for the production delivery snapshot
": "{String}",PercentCompleted
User defined percent completed of the project
": "{Decimal}",IsLastDayOfAccountingPeriod
This date is last day of a accounting period.
": "{Boolean}",Currency
Three character code following the ISO 4217 standard
": "{String}",SalesBacklog
Total sales backlog of the delivery project
": "{Decimal}",AccruedIncome
Salesbacklog multiplied with percent completed. If percent completed is not specified for the production delivery snapshot, the accrued income is aggregated from each of the work breakdown structure elements. The accrued income will be the same as invoiced amount by the end of the delivery project.
": "{Decimal}",InvoicedAmount
Total invoiced amount of the delivery project
": "{Decimal}",AdvanceInvoicedAmount
Total advance invoice amount for the delivery project
": "{Decimal}",SalesValue
Totals.SalesBacklog + Totals.InvoicedAmount
": "{Decimal}",Hours
Total accrued hours for the delivery project
": "{Decimal}",MaterialCost
SUMPLANNEDMATERIALCOST
": "{Decimal}",FixedAdditionalCost
SUMPLANNEDADDEDFIXEDCOST
": "{Decimal}",VariableAdditionalCost
SUMPLANNEDADDEDVARCOST
": "{Decimal}",FixedOperationCost
SUMPLANNEDOPERATIONFIXEDCOST
": "{Decimal}",VariableOperationCost
SUMPLANNEDOPERATIONVARCOST
": "{Decimal}",TotalCost
Total planned cost of the delivery project
": "{Decimal}"Hours
Total accrued hours for the delivery project
": "{Decimal}",MaterialCost
SUMACCRUEDMATERIALCOST
": "{Decimal}",FixedAdditionalCost
SUMACCRUEDADDEDFIXEDCOST
": "{Decimal}",VariableAdditionalCost
SUMACCRUEDADDEDVARCOST
": "{Decimal}",FixedOperationCost
SUMACCRUEDOPERATIONFIXEDCOST
": "{Decimal}",VariableOperationCost
SUMACCRUEDOPERATIONVARCOST
": "{Decimal}",TotalCost
Total accrued cost of the delivery project
": "{Decimal}"CostOfGoods
Field from finance linked to PRO by PRO.PRJNO.
'Other cost of goods' for a delivery project are 'material' costs that are not already included based on accumulated values for material/parts that are linked to the included COA items or via work orders (PWOs) that are linked to the COA items and connected sub PWOs. So other cost of goods must exclude the general ledger (GL) accounts that are connected to inventory flow.
SalaryCost
Field from finance linked to PRO by PRO.PRJNO.
Project wages is project labour cost that is not already added via the logged work at the included work orders (PWOs), example: Engineering cost.
To be connected to PRS by a dedicated ACG.
OtherCost
Field from finance linked to PRO by PRO.PRJNO.
": "{Decimal}",Income
Field from finance linked to PRO by PRO.PRJNO.
User must exclude the GL accounts that are used for invoices that are created based on the customer orders (COAs) that are linked to the PRO.
StockValue
Inventory value for a delivery project is sum of all inventory on the related finance project. Use SVR with filter on the given project to find the correct value.
": "{Decimal}"Income
InvoicedAmount + OtherIncome
": "{Decimal}",Cost
Accrued.ToyalCost + OtherCostOfGoods + Wages + OtherExpences
": "{Decimal}",Profit
TotalIncome - TotalCost
": "{Decimal}"DeliveryProjectId
Sales delivery project identifier
": "{Integer}",Name
Name of sales delivery
": "{String}",DeliveryProjectLink
Sales delivery project reference
": "{String}"ProductionDeliverySnapshotLink
Production delivery snapshot 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 |