Sales APIs
Project order details for the provided identifier
HTTP method | GET |
URI | https://api.rambase.net/sales/project-orders/{projectOrderId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {projectOrderId} |
Project order identifier
Integer, minimum 100000 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 4025, version 66 |
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 |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$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. |
$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. |
$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. |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
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.
ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of the project order
>{String}</Name>Description
Description of the project order
>{String}</Description>PricingModel
States if there are a fixed price for the project order, or if price will be based on time and material
Possible domain values can be found here
>{String}</PricingModel>IsInternal
True if this is an internal project order
>{Boolean}</IsInternal>Note
A note to be added to the project order. Will typically be printed.
>{String}</Note>InternalNote
An internal note to be added to the project order
>{String}</InternalNote>CustomersReference
Customers reference. Typically a person.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>RegistrationDate
Date of registration
>{Date}</RegistrationDate>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>InitialEstimatedGrossMargin
Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal
>{Decimal}</InitialEstimatedGrossMargin>ForecastGrossMargin
Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal
>{Decimal}</ForecastGrossMargin>ExternalReference
External identifier
>{String}</ExternalReference>EstimatedStartAt
Estimated start date and time
>{Datetime}</EstimatedStartAt>EstimatedCompleteAt
Estimated end date and time
>{Datetime}</EstimatedCompleteAt>PercentWorkComplete
Work done in percentage, to be manually updated by responsible user
>{Decimal}</PercentWorkComplete>LastCalculatedAt
Date of last calculation of sales and cost numbers
>{Datetime}</LastCalculatedAt>CalculateMarkupByDefault
If "True" it means that new PODITEMs that are created will have markup calculated. If "False" it means that they will not have markup calculated, -means markup is disabled
>{Boolean}</CalculateMarkupByDefault>ItemId
Item-number of the object
>{Integer}</ItemId>Status
Status of the item/object.
>{Integer}</Status>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>Department
Accounting department to be used as a default for items that are created for project order
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The finance project related to the project order. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>CustomerLink
Customer reference
>{String}</CustomerLink>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>Responsible
Reference to the user who is responsible project manger for this project order
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>InitialEstimatedHours
The number of hours that are initial estimated to be used on this project order.
>{Decimal}</InitialEstimatedHours>InitialEstimatedAmount
Total Intial estimated revenues for hours at the time the project order is started. In sales currency.
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedHours
Sum of all remaining estimated hours.
>{Decimal}</RemainingEstimatedHours>RemainingEstimatedAmount
Total remaining estimated revenues for hours, in sales currency
>{Decimal}</RemainingEstimatedAmount>PendingHours
Sum of all hours that are logged, but not yet approved by manager (status 3)
>{Decimal}</PendingHours>PendingAmount
Total pending revenues for hours, in sales currency. Revenues for hours are to be understood as pending when they are logged, but not yet approved by manager (status 3)
>{Decimal}</PendingAmount>AccruedHours
Sum of all logged hours that have been approved by manager (status 4)
>{Decimal}</AccruedHours>AccruedAmount
Total accrued revenues for hours, in sales currency.
>{Decimal}</AccruedAmount>ForecastHours
Sum of all forecasted hours to be used in this project order
>{Decimal}</ForecastHours>ForecastAmount
Total forecasted revenues for hours, in sales currency.
>{Decimal}</ForecastAmount>InvoicedAmount
Total invoiced revenues for hours. In sales currency.
>{Decimal}</InvoicedAmount>InitialEstimatedAmount
Total Intial estimated revenues for material at the time the project order is started. In sales currency.
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining estimated revenues for material, in sales currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending revenues for material, in sales currency. Revenues for material are to be understood as pending when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
>{Decimal}</PendingAmount>AccruedAmount
Total accrued revenues for material, in sales currency.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted revenues for material, in sales currency.
>{Decimal}</ForecastAmount>InvoicedAmount
Total invoiced revenues for material. In sales currency.
>{Decimal}</InvoicedAmount>InitialEstimatedAmount
Total initial estimated revenues for expenses at the time the project order is started. In sales currency.
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining estimated revenues for expenses. In sales currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending revenues for expenses. In sales currency.|
>{Decimal}</PendingAmount>AccruedAmount
Total accrued revenues for expenses, in sales currency.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted revenues for expenses, in sales currency.
>{Decimal}</ForecastAmount>InvoicedAmount
Total invoiced revenues for expenses. In sales currency
>{Decimal}</InvoicedAmount>InitialEstimatedAmount
Total initial estimated revenues at the time the project order is registered, in sales currency. Includes initial estimated revenues for both hours, material and expenses.
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining estimated revenues, in sales currency. Includes revenues for both hours, material and expenses.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending revenues, in sales currency. Includes pending revenues for both hours, material and expenses.
>{Decimal}</PendingAmount>AccruedAmount
Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and expenses.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecast revenues for the project order, in sales currency. Includes forecast revenue for both hour, material and expenses for a project order with price model 'Time & material'. For price model 'Fixed price' it's equal to the sales price that is given to the customer in the belonging sales transaction.
>{Decimal}</ForecastAmount>InvoicedAmount
Total invoiced revenues, in sales currency. Includes invoiced revenues for both hours, material and expenses.
>{Decimal}</InvoicedAmount>VATType
Type of value added tax
>{String}</VATType>ProjectOrderId
Project order identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of project order
Possible domain values can be found here
": "{Integer}",Name
Name of the project order
": "{String}",Description
Description of the project order
": "{String}",PricingModel
States if there are a fixed price for the project order, or if price will be based on time and material
Possible domain values can be found here
": "{String}",IsInternal
True if this is an internal project order
": "{Boolean}",Note
A note to be added to the project order. Will typically be printed.
": "{String}",InternalNote
An internal note to be added to the project order
": "{String}",CustomersReference
Customers reference. Typically a person.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",RegistrationDate
Date of registration
": "{Date}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",InitialEstimatedGrossMargin
Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal
": "{Decimal}",ForecastGrossMargin
Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal
": "{Decimal}",ExternalReference
External identifier
": "{String}",EstimatedStartAt
Estimated start date and time
": "{Datetime}",EstimatedCompleteAt
Estimated end date and time
": "{Datetime}",PercentWorkComplete
Work done in percentage, to be manually updated by responsible user
": "{Decimal}",LastCalculatedAt
Date of last calculation of sales and cost numbers
": "{Datetime}",CalculateMarkupByDefault
If "True" it means that new PODITEMs that are created will have markup calculated. If "False" it means that they will not have markup calculated, -means markup is disabled
": "{Boolean}",ItemId
Item-number of the object
": "{Integer}",Status
Status of the item/object.
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"Department
Accounting department to be used as a default for items that are created for project order
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The finance project related to the project order. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"Responsible
Reference to the user who is responsible project manger for this project order
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",InitialEstimatedHours
The number of hours that are initial estimated to be used on this project order.
": "{Decimal}",InitialEstimatedAmount
Total Intial estimated revenues for hours at the time the project order is started. In sales currency.
": "{Decimal}",RemainingEstimatedHours
Sum of all remaining estimated hours.
": "{Decimal}",RemainingEstimatedAmount
Total remaining estimated revenues for hours, in sales currency
": "{Decimal}",PendingHours
Sum of all hours that are logged, but not yet approved by manager (status 3)
": "{Decimal}",PendingAmount
Total pending revenues for hours, in sales currency. Revenues for hours are to be understood as pending when they are logged, but not yet approved by manager (status 3)
": "{Decimal}",AccruedHours
Sum of all logged hours that have been approved by manager (status 4)
": "{Decimal}",AccruedAmount
Total accrued revenues for hours, in sales currency.
": "{Decimal}",ForecastHours
Sum of all forecasted hours to be used in this project order
": "{Decimal}",ForecastAmount
Total forecasted revenues for hours, in sales currency.
": "{Decimal}",InvoicedAmount
Total invoiced revenues for hours. In sales currency.
": "{Decimal}"InitialEstimatedAmount
Total Intial estimated revenues for material at the time the project order is started. In sales currency.
": "{Decimal}",RemainingEstimatedAmount
Total remaining estimated revenues for material, in sales currency.
": "{Decimal}",PendingAmount
Total pending revenues for material, in sales currency. Revenues for material are to be understood as pending when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
": "{Decimal}",AccruedAmount
Total accrued revenues for material, in sales currency.
": "{Decimal}",ForecastAmount
Total forecasted revenues for material, in sales currency.
": "{Decimal}",InvoicedAmount
Total invoiced revenues for material. In sales currency.
": "{Decimal}"InitialEstimatedAmount
Total initial estimated revenues for expenses at the time the project order is started. In sales currency.
": "{Decimal}",RemainingEstimatedAmount
Total remaining estimated revenues for expenses. In sales currency.
": "{Decimal}",PendingAmount
Total pending revenues for expenses. In sales currency.|
": "{Decimal}",AccruedAmount
Total accrued revenues for expenses, in sales currency.
": "{Decimal}",ForecastAmount
Total forecasted revenues for expenses, in sales currency.
": "{Decimal}",InvoicedAmount
Total invoiced revenues for expenses. In sales currency
": "{Decimal}"InitialEstimatedAmount
Total initial estimated revenues at the time the project order is registered, in sales currency. Includes initial estimated revenues for both hours, material and expenses.
": "{Decimal}",RemainingEstimatedAmount
Total remaining estimated revenues, in sales currency. Includes revenues for both hours, material and expenses.
": "{Decimal}",PendingAmount
Total pending revenues, in sales currency. Includes pending revenues for both hours, material and expenses.
": "{Decimal}",AccruedAmount
Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and expenses.
": "{Decimal}",ForecastAmount
Total forecast revenues for the project order, in sales currency. Includes forecast revenue for both hour, material and expenses for a project order with price model 'Time & material'. For price model 'Fixed price' it's equal to the sales price that is given to the customer in the belonging sales transaction.
": "{Decimal}",InvoicedAmount
Total invoiced revenues, in sales currency. Includes invoiced revenues for both hours, material and expenses.
": "{Decimal}",VATType
Type of value added tax
": "{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 102120 HTTP 404 | Delivery project not found |
Error 100104 HTTP 404 | Address not found |
Error 100001 HTTP 404 | Address not found |