Production APIs
Delivery project snapshots
| Report name | Delivery Project Snapshots |
| Report identifier | 113503 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/113503/result-set |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 5995, version 4 |
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.
| CustomerId Integer | Customer identifier. |
| Date Date | Date of production delivery snapshot. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| FinanceProjectId Integer | Finance project identifier. |
| IsLastDayOfAccountingPeriod Boolean | This date is last day of a accounting period. |
| Milestone String | User defined milestone for production delivery snapshot. |
| Name String | Name of sales delivery. |
| PercentCompleted Decimal | User defined percent completed of the project. |
| ProductionDeliverySnapshotId Integer | Production delivery snapshot identifier. |
| SalesDeliveryProjectId Integer | Sales delivery project identifier. |
| SalesDeliveryProjectName String | Name of sales delivery. |
| Status Integer | Status of sales delivery. |
Read more about filters and sorting on how to use sortable parameters
| CustomerId Integer | Customer identifier |
| Date Date | Date of production delivery snapshot |
| FinanceProjectId Integer | Finance project identifier |
| IsLastDayOfAccountingPeriod Boolean | This date is last day of a accounting period. |
| Milestone String | User defined milestone for production delivery snapshot |
| Name String | Name of sales delivery |
| PercentCompleted Decimal | User defined percent completed of the project |
| ProductionDeliverySnapshotId Integer | Production delivery snapshot identifier |
| SalesDeliveryProjectId Integer | Sales delivery project identifier |
| SalesDeliveryProjectName String | Name of sales delivery |
| Status Integer | Status of sales delivery |
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.
SalesDeliveryProject
Sales delivery project identifier
>SalesDeliveryProjectId
Sales delivery project identifier
>{Integer}</SalesDeliveryProjectId>Status
Status of sales delivery
>{Integer}</Status>Name
Name of sales delivery
>{String}</Name>SalesDeliveryProjectLink
Sales delivery project reference
>{String}</SalesDeliveryProjectLink>ProductionDeliverySnapshot
Production delivery snapshot identifier
>ProductionDeliverySnapshotId
Production delivery snapshot identifier
>{Integer}</ProductionDeliverySnapshotId>ProductionDeliverySnapshotLink
Production delivery snapshot reference
>{String}</ProductionDeliverySnapshotLink>Date
Date of production delivery snapshot
>{Date}</Date>Milestone
User defined milestone for production delivery snapshot
>{String}</Milestone>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>PlannedTotalCost
Total planned cost of the delivery project
>{Decimal}</PlannedTotalCost>AccruedTotalCost
Total accrued cost of the delivery project
>{Decimal}</AccruedTotalCost>PlannedHours
Total accrued hours for the delivery project
>{Decimal}</PlannedHours>AccruedHours
Total accrued hours for the delivery project
>{Decimal}</AccruedHours>SalesBacklog
Total sales backlog of the delivery project
>{Decimal}</SalesBacklog>PercentCompleted
User defined percent completed of the project
>{Decimal}</PercentCompleted>AdvanceInvoicedAmount
Total advance invoice amount for the delivery project
>{Decimal}</AdvanceInvoicedAmount>PlannedMaterialCost
SUMPLANNEDMATERIALCOST
>{Decimal}</PlannedMaterialCost>AccruedMaterialCost
SUMACCRUEDMATERIALCOST
>{Decimal}</AccruedMaterialCost>PlannedVariableOperationCost
SUMPLANNEDOPERATIONVARCOST
>{Decimal}</PlannedVariableOperationCost>AccruedVariableOperationCost
SUMACCRUEDOPERATIONVARCOST
>{Decimal}</AccruedVariableOperationCost>PlannedFixedOperationCost
SUMPLANNEDOPERATIONFIXEDCOST
>{Decimal}</PlannedFixedOperationCost>AccruedFixedOperationCost
SUMACCRUEDOPERATIONFIXEDCOST
>{Decimal}</AccruedFixedOperationCost>PlannedVariableAdditionalCost
SUMPLANNEDADDEDVARCOST
>{Decimal}</PlannedVariableAdditionalCost>AccruedVariableAdditionalCost
SUMACCRUEDADDEDVARCOST
>{Decimal}</AccruedVariableAdditionalCost>PlannedFixedAdditionalCost
SUMPLANNEDADDEDFIXEDCOST
>{Decimal}</PlannedFixedAdditionalCost>AccruedFixedAdditionalCost
SUMACCRUEDADDEDFIXEDCOST
>{Decimal}</AccruedFixedAdditionalCost>AccruedCostActive
Production cost: Accrued cost for active work orders, PWO with ST<9.
>{Decimal}</AccruedCostActive>AccruedCostFinished
Cost finished productions: Real (accrued) cost for work orders that are forwarded to stock (PWO is forwarded to SSA) but where the SSA is still in stock, the COA item is not forwarded to a CSA that is shipped (ST>3)
>{Decimal}</AccruedCostFinished>AccruedCostShipped
Shipped cost: Accrued (real) cost for prod SSAs for COA items that are delivered, the CSA has ST>3
>{Decimal}</AccruedCostShipped>IsLastDayOfAccountingPeriod
This date is last day of a accounting period.
>{Boolean}</IsLastDayOfAccountingPeriod>OtherCostOfGoods
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.
OtherExpences
Field from finance linked to PRO by PRO.PRJNO.
>{Decimal}</OtherExpences>OtherIncome
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.
TotalIncome
InvoicedAmount + OtherIncome
>{Decimal}</TotalIncome>TotalCost
Accrued.ToyalCost + OtherCostOfGoods + Wages + OtherExpences
>{Decimal}</TotalCost>Profit
TotalIncome - TotalCost
>{Decimal}</Profit>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>Customer
Customer reference
>CustomerId
Customer identifier
>{Integer}</CustomerId>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>FinanceProject
Finance project reference. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>Name
Name of finance project
>{String}</Name>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>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>SalesDeliveryProject
Sales delivery project identifier
": {SalesDeliveryProjectId
Sales delivery project identifier
": "{Integer}",Status
Status of sales delivery
": "{Integer}",Name
Name of sales delivery
": "{String}",SalesDeliveryProjectLink
Sales delivery project reference
": "{String}"ProductionDeliverySnapshot
Production delivery snapshot identifier
": {ProductionDeliverySnapshotId
Production delivery snapshot identifier
": "{Integer}",ProductionDeliverySnapshotLink
Production delivery snapshot reference
": "{String}"Date
Date of production delivery snapshot
": "{Date}",Milestone
User defined milestone for production delivery snapshot
": "{String}",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}",PlannedTotalCost
Total planned cost of the delivery project
": "{Decimal}",AccruedTotalCost
Total accrued cost of the delivery project
": "{Decimal}",PlannedHours
Total accrued hours for the delivery project
": "{Decimal}",AccruedHours
Total accrued hours for the delivery project
": "{Decimal}",SalesBacklog
Total sales backlog of the delivery project
": "{Decimal}",PercentCompleted
User defined percent completed of the project
": "{Decimal}",AdvanceInvoicedAmount
Total advance invoice amount for the delivery project
": "{Decimal}",PlannedMaterialCost
SUMPLANNEDMATERIALCOST
": "{Decimal}",AccruedMaterialCost
SUMACCRUEDMATERIALCOST
": "{Decimal}",PlannedVariableOperationCost
SUMPLANNEDOPERATIONVARCOST
": "{Decimal}",AccruedVariableOperationCost
SUMACCRUEDOPERATIONVARCOST
": "{Decimal}",PlannedFixedOperationCost
SUMPLANNEDOPERATIONFIXEDCOST
": "{Decimal}",AccruedFixedOperationCost
SUMACCRUEDOPERATIONFIXEDCOST
": "{Decimal}",PlannedVariableAdditionalCost
SUMPLANNEDADDEDVARCOST
": "{Decimal}",AccruedVariableAdditionalCost
SUMACCRUEDADDEDVARCOST
": "{Decimal}",PlannedFixedAdditionalCost
SUMPLANNEDADDEDFIXEDCOST
": "{Decimal}",AccruedFixedAdditionalCost
SUMACCRUEDADDEDFIXEDCOST
": "{Decimal}",AccruedCostActive
Production cost: Accrued cost for active work orders, PWO with ST<9.
": "{Decimal}",AccruedCostFinished
Cost finished productions: Real (accrued) cost for work orders that are forwarded to stock (PWO is forwarded to SSA) but where the SSA is still in stock, the COA item is not forwarded to a CSA that is shipped (ST>3)
": "{Decimal}",AccruedCostShipped
Shipped cost: Accrued (real) cost for prod SSAs for COA items that are delivered, the CSA has ST>3
": "{Decimal}",IsLastDayOfAccountingPeriod
This date is last day of a accounting period.
": "{Boolean}",OtherCostOfGoods
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.
OtherExpences
Field from finance linked to PRO by PRO.PRJNO.
": "{Decimal}",OtherIncome
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.
TotalIncome
InvoicedAmount + OtherIncome
": "{Decimal}",TotalCost
Accrued.ToyalCost + OtherCostOfGoods + Wages + OtherExpences
": "{Decimal}",Profit
TotalIncome - TotalCost
": "{Decimal}",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}",Customer
Customer reference
": {CustomerId
Customer identifier
": "{Integer}",FirstName
Secondary name of a company or firstname of a person
": "{String}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}"FinanceProject
Finance project reference. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",Name
Name of finance project
": "{String}",FinanceProjectLink
Finance project reference
": "{String}"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 |