Sales APIs
Resource for creating new project order
| HTTP method | POST |
| URI | https://api.rambase.net/sales/project-orders |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 4029, version 11 |
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.
Name
Name of the project order
This field is optional.
>{String}</Name>PricingModel
Required/mandatory field
States if there are a fixed price for the project order, or if price will be based on time and material
Applicable domain values can be found here
>{String}</PricingModel>IsInternal
True if this is an internal project order
Default value: False
This field is optional.
>{Boolean}</IsInternal>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
This field is optional.
>{Boolean}</CalculateMarkupByDefault>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
>{String}</Currency>LocationId
Required/mandatory field
Location identifier
Minimum value: 10000
>{Integer}</LocationId>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>ShippingAddress
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Name
Name of the project order
This field is optional.
": "{String}",PricingModel
Required/mandatory field
States if there are a fixed price for the project order, or if price will be based on time and material
Applicable domain values can be found here
": "{String}",IsInternal
True if this is an internal project order
Default value: False
This field is optional.
": "{Boolean}",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
This field is optional.
": "{Boolean}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
": "{String}",LocationId
Required/mandatory field
Location identifier
Minimum value: 10000
": "{Integer}"Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $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] |
| $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.
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
>SalesInvoiceItemId
Reference to the item id of the object
>{Integer}</SalesInvoiceItemId>SalesInvoiceId
Identifier of the object
>{Integer}</SalesInvoiceId>SalesInvoiceLink
Document reference
>{String}</SalesInvoiceLink>SalesInvoiceItemLink
Document item reference
>{String}</SalesInvoiceItemLink>ItemId
Item-number of the object
>{Integer}</ItemId>Status
Status of the item/object.
>PaymentTerms
Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.
Possible domain values can be found here
>{String}</PaymentTerms>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>AddressId
Address identifier
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>Phone
Shipping address phone number
>{String}</Phone>AddressLink
Address reference
>{String}</AddressLink>AddressId
Address identifier
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>Country
English name of country.
>{String}</Country>AddressLink
Address reference
>{String}</AddressLink>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>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>InitialEstimatedAmount
Total initial estimated revenues for hours at the time the project order is started, in local currency
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining revenues for hours, in local currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending revenues for hours, in local currency. Revenues for hours are to be understood as pending if hours are logged, but not yet approved by manager (status 3)
>{Decimal}</PendingAmount>AccruedAmount
Total accrued revenues for hours, in local currency. Revenues for hours are to be understood as accrued when logged hours has been approved by manager (status 4)
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted revenues for hours, in local currency
>{Decimal}</ForecastAmount>InvoicedAmount
Total invoiced revenues for hours, in local currency
>{Decimal}</InvoicedAmount>InitialEstimatedAmount
Total initial estimated revenues for material at the time the project order is started, in local currency
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining revenues for material, in local currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending revenues for material, in local 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 local currency. Revenues for material are to be understood as accrued when material have been shipped out the warehouse.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted revenues for material, in local currency
>{Decimal}</ForecastAmount>InvoicedAmount
Total invoiced revenues for material, in local currency
>{Decimal}</InvoicedAmount>InitialEstimatedAmount
Total initial estimated revenues for expenses at the time the project order is started, in local currency
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining revenues for expenses, in local currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending revenues for expenses, in local currency. Revenues are understood as pending when purchaser order for expenses are registered.
>{Decimal}</PendingAmount>AccruedAmount
Total accrued revenues for expenses, in local currency. Revenues for expenses are normally understood as accrued when supplier invoice is registered. Eventually can accrued revenues be set manually.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted revenues for expenses, in local currency.
>{Decimal}</ForecastAmount>InvoicedAmount
Total invoiced revenues for expenses, in local currency
>{Decimal}</InvoicedAmount>InitialEstimatedAmount
Total initial estimated revenues at the time the project order is registered, in local currency. Includes initial estimated revenues for both material, hours and expenses.
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining estimated revenues, in local currency. Includes remaining estimated revenues for both hours, material and expenses.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending revenues, in local currency. Includes pending revenues for both hours, material and expenses
>{Decimal}</PendingAmount>AccruedAmount
Total accrued revenues, in local currency. Includes accrued revenues for both hours, material and expenses.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted revenues, in local currency, for both hours, material and expenses. Forecasted revenues are a sum of remaining, pending and accrued revenues 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 local currency. Includes invoiced revenues for both hours, material and expenses.
>{Decimal}</InvoicedAmount>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>InitialEstimatedAmount
Total initial estimated cost of hours at the time the project order is started, in local currency.
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining cost of hours, in local currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending cost of hours, in local currency. Cost for hours are to be understood as pending if hours are logged, but not yet approved by manager (status 3)
>{Decimal}</PendingAmount>AccruedAmount
Total accrued cost of hours, in local currency. Cost for hours are to be understood as accrued when logged hours has been approved by manager (status 4)
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted cost of hours, in local currency
>{Decimal}</ForecastAmount>InitialEstimatedAmount
Total initial estimated cost of material at the time the project order is started, in local currency
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining cost of material, in local currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending cost of material, in local currency. Cost for material are to be understood as pending if 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 cost of material, in local currency. Cost are to be understood as accrued for material when it has been shipped out of the warehouse.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted cost of material, in local currency
>{Decimal}</ForecastAmount>InitialEstimatedAmount
Total initial estimated cost of expenses at the time the project order is started, in local currency
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining cost of expenses, in local currency.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending cost of expenses, in local currency. Expenses are understood as pending when a purchase order for expenses are registered.
>{Decimal}</PendingAmount>AccruedAmount
Total accrued cost of expenses, in local currency
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted cost of expenses, in local currency
>{Decimal}</ForecastAmount>InitialEstimatedAmount
Total initial estimated cost at the time the project order is registered, in local currency. Includes initial estimated cost for both material, hours and expenses.
>{Decimal}</InitialEstimatedAmount>RemainingEstimatedAmount
Total remaining estimated cost, in local currency. Includes remaining cost from both hours, material and expenses.
>{Decimal}</RemainingEstimatedAmount>PendingAmount
Total pending cost, in local currency. Includes pending cost for both hours, material and expenses.
>{Decimal}</PendingAmount>AccruedAmount
Total accrued cost, in local currency. Includes accrued cost for both hours, material and expenses.
>{Decimal}</AccruedAmount>ForecastAmount
Total forecasted cost, in local currency, for both hours, material and expenses. Forecasted cost is a sum of remaining, pending and accrued cost.
>{Decimal}</ForecastAmount>VATType
Type of value added tax
>{String}</VATType>NotificationId
Notification identifier
>{Integer}</NotificationId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationLink
Notification reference
>{String}</NotificationLink>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
": {SalesInvoiceItemId
Reference to the item id of the object
": "{Integer}",SalesInvoiceId
Identifier of the object
": "{Integer}",SalesInvoiceLink
Document reference
": "{String}"SalesInvoiceItemLink
Document item reference
": "{String}"ItemId
Item-number of the object
": "{Integer}",Status
Status of the item/object.
": {PaymentTerms
Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.
Possible domain values can be found here
": "{String}"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}",AddressId
Address identifier
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",Phone
Shipping address phone number
": "{String}",AddressLink
Address reference
": "{String}",AddressId
Address identifier
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",Country
English name of country.
": "{String}",AddressLink
Address 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}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",InitialEstimatedAmount
Total initial estimated revenues for hours at the time the project order is started, in local currency
": "{Decimal}",RemainingEstimatedAmount
Total remaining revenues for hours, in local currency.
": "{Decimal}",PendingAmount
Total pending revenues for hours, in local currency. Revenues for hours are to be understood as pending if hours are logged, but not yet approved by manager (status 3)
": "{Decimal}",AccruedAmount
Total accrued revenues for hours, in local currency. Revenues for hours are to be understood as accrued when logged hours has been approved by manager (status 4)
": "{Decimal}",ForecastAmount
Total forecasted revenues for hours, in local currency
": "{Decimal}",InvoicedAmount
Total invoiced revenues for hours, in local currency
": "{Decimal}"InitialEstimatedAmount
Total initial estimated revenues for material at the time the project order is started, in local currency
": "{Decimal}",RemainingEstimatedAmount
Total remaining revenues for material, in local currency.
": "{Decimal}",PendingAmount
Total pending revenues for material, in local 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 local currency. Revenues for material are to be understood as accrued when material have been shipped out the warehouse.
": "{Decimal}",ForecastAmount
Total forecasted revenues for material, in local currency
": "{Decimal}",InvoicedAmount
Total invoiced revenues for material, in local currency
": "{Decimal}"InitialEstimatedAmount
Total initial estimated revenues for expenses at the time the project order is started, in local currency
": "{Decimal}",RemainingEstimatedAmount
Total remaining revenues for expenses, in local currency.
": "{Decimal}",PendingAmount
Total pending revenues for expenses, in local currency. Revenues are understood as pending when purchaser order for expenses are registered.
": "{Decimal}",AccruedAmount
Total accrued revenues for expenses, in local currency. Revenues for expenses are normally understood as accrued when supplier invoice is registered. Eventually can accrued revenues be set manually.
": "{Decimal}",ForecastAmount
Total forecasted revenues for expenses, in local currency.
": "{Decimal}",InvoicedAmount
Total invoiced revenues for expenses, in local currency
": "{Decimal}"InitialEstimatedAmount
Total initial estimated revenues at the time the project order is registered, in local currency. Includes initial estimated revenues for both material, hours and expenses.
": "{Decimal}",RemainingEstimatedAmount
Total remaining estimated revenues, in local currency. Includes remaining estimated revenues for both hours, material and expenses.
": "{Decimal}",PendingAmount
Total pending revenues, in local currency. Includes pending revenues for both hours, material and expenses
": "{Decimal}",AccruedAmount
Total accrued revenues, in local currency. Includes accrued revenues for both hours, material and expenses.
": "{Decimal}",ForecastAmount
Total forecasted revenues, in local currency, for both hours, material and expenses. Forecasted revenues are a sum of remaining, pending and accrued revenues 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 local currency. Includes invoiced revenues for both hours, material and expenses.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",InitialEstimatedAmount
Total initial estimated cost of hours at the time the project order is started, in local currency.
": "{Decimal}",RemainingEstimatedAmount
Total remaining cost of hours, in local currency.
": "{Decimal}",PendingAmount
Total pending cost of hours, in local currency. Cost for hours are to be understood as pending if hours are logged, but not yet approved by manager (status 3)
": "{Decimal}",AccruedAmount
Total accrued cost of hours, in local currency. Cost for hours are to be understood as accrued when logged hours has been approved by manager (status 4)
": "{Decimal}",ForecastAmount
Total forecasted cost of hours, in local currency
": "{Decimal}"InitialEstimatedAmount
Total initial estimated cost of material at the time the project order is started, in local currency
": "{Decimal}",RemainingEstimatedAmount
Total remaining cost of material, in local currency.
": "{Decimal}",PendingAmount
Total pending cost of material, in local currency. Cost for material are to be understood as pending if the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
": "{Decimal}",AccruedAmount
Total accrued cost of material, in local currency. Cost are to be understood as accrued for material when it has been shipped out of the warehouse.
": "{Decimal}",ForecastAmount
Total forecasted cost of material, in local currency
": "{Decimal}"InitialEstimatedAmount
Total initial estimated cost of expenses at the time the project order is started, in local currency
": "{Decimal}",RemainingEstimatedAmount
Total remaining cost of expenses, in local currency.
": "{Decimal}",PendingAmount
Total pending cost of expenses, in local currency. Expenses are understood as pending when a purchase order for expenses are registered.
": "{Decimal}",AccruedAmount
Total accrued cost of expenses, in local currency
": "{Decimal}",ForecastAmount
Total forecasted cost of expenses, in local currency
": "{Decimal}"InitialEstimatedAmount
Total initial estimated cost at the time the project order is registered, in local currency. Includes initial estimated cost for both material, hours and expenses.
": "{Decimal}",RemainingEstimatedAmount
Total remaining estimated cost, in local currency. Includes remaining cost from both hours, material and expenses.
": "{Decimal}",PendingAmount
Total pending cost, in local currency. Includes pending cost for both hours, material and expenses.
": "{Decimal}",AccruedAmount
Total accrued cost, in local currency. Includes accrued cost for both hours, material and expenses.
": "{Decimal}",ForecastAmount
Total forecasted cost, in local currency, for both hours, material and expenses. Forecasted cost is a sum of remaining, pending and accrued cost.
": "{Decimal}"VATType
Type of value added tax
": "{String}",NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"NotificationLink
Notification reference
": "{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 103158 HTTP 400 | It is not allowed to change product in a shipping advice item |
| Error 107812 HTTP 400 | End customer not found |
| Error 107813 HTTP 400 | The end customer is not active |
| Error 101396 HTTP 400 | Maximum number of lines exceeded |
| Error 106448 HTTP 400 | A sales order item for product of type project order (WP) cannot be splitted into several items |
| Error 106476 HTTP 400 | This type of product (WP) can only be changed into a product of the same type |
| Error 106408 HTTP 403 | You have no permission to create subscription item in sales order |
| Error 106957 HTTP 400 | Only rental or subscription products can be used in recurring contract's lines |
| Error 106962 HTTP 400 | Product of this type (WP) cannot be added to this type of sales order |
| Error 107055 HTTP 400 | The rental date can only be set back {0} days |
| Error 102485 HTTP 400 | Dimension {0} ({1}) is required for general ledger account {2} |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 109539 HTTP 400 | Dimension value {0} could not be used : Check its FromPeriod and ToPeriod. |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |