Sales APIs
List of project orders
HTTP method | GET |
URI | https://api.rambase.net/sales/project-orders?onlyBillableSales={onlyBillableSales}&minimumBillableSalesAmount={minBillableSalesAmount}&maximumBillableSalesAmount={maxBillableSalesAmount}&latestIncurredCostDate={latestIncurredCostDate} |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 4031, version 35 |
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 project orders (false) or only those project orders, which have billing basis (true). |
minimumBillableSalesAmount Decimal, optional | Amount limit, in local currency, which restricts project orders to the ones with billing basis amount less than specified value. |
maximumBillableSalesAmount Decimal, optional | Amount limit, in local currency, which restricts project orders to the ones with billing basis greater than specified value. |
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.
Active() Named filter | Project orders which are active (status 4) |
LastInvoice() Named filter | Project orders which are pending last invoicing (status 8) |
MyProjectOrders() Named filter | Project orders for which the current user either belongs to the project team or is project leader for |
New() Named filter | Project orders which are not registered (status 1 and 2) |
Ongoing() Named filter | Project orders which are registered, but not yet not processed (status greater than 2 and lower than 9) |
OpenProgressComplete() Named filter | Project orders which are open but with a 100 % progress |
Paused() Named filter | Project orders which are paused (status 5) |
Processed() Named filter | Project orders which are processed (status 9) |
UnreadNotification() Named filter | Project orders with unread notification |
UnregisteredBillings() Named filter | Project orders which have sales invoice or credit note that is not yet registered (status 1) |
AccruedSaleTotal Decimal | Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and 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. |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Currency String | Three character code following the ISO 4217 standard. |
CustomerFirstName String | Secondary name of a company or firstname of a person. |
CustomerId Integer | Customer identifier. |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
CustomersReference String | Customers reference. Typically a person. |
CustomersReferenceNumber String | Customers reference number. E.g. the internal sales order id the customer use in their own system. |
IsInternal Boolean | True if this is an internal project order. |
Name String | Name of the project order. |
PercentWorkComplete Decimal | Work done in percentage, to be manually updated by responsible user. |
PricingModel String | States if there are a fixed price for the project order, or if price will be based on time and material. |
ProjectManagerEmployeeId Integer | Employee identifier. Available macros: currentUser() |
ProjectOrderId Integer | Project order identifier. |
Status Integer | Status of project order. |
Read more about filters and sorting on how to use sortable parameters
AccruedSaleTotal Decimal | Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and 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 |
CreatedAt Datetime | Date and time of creation |
Currency String | Three character code following the ISO 4217 standard |
CustomerFirstName String | Secondary name of a company or firstname of a person |
CustomerId Integer | Customer identifier |
CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
CustomersReference String | Customers reference. Typically a person. |
CustomersReferenceNumber String | Customers reference number. E.g. the internal sales order id the customer use in their own system. |
IsInternal Boolean | True if this is an internal project order |
Name String | Name of the project order |
PercentWorkComplete Decimal | Work done in percentage, to be manually updated by responsible user |
PricingModel String | States if there are a fixed price for the project order, or if price will be based on time and material |
ProjectManagerEmployeeId Integer | Employee identifier |
ProjectOrderId Integer | Project order identifier |
Status Integer | Status of project order |
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>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>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>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>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>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>ProjectOrderLink
Project order reference
>{String}</ProjectOrderLink>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>ProjectOrderId
Project order identifier
": "{Integer}",Status
Status of project order
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name 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}",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}",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}",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}"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}"ProjectOrderLink
Project order 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 100089 HTTP 404 | Product {0} not found |