Procurement APIs
Resource for creating new purchase quote requests. Note that only supplier is required.
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/quote-requests |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 2748, version 5 |
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.
SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
>{String}</SuppliersReference>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
>{String}</Note>Validity
This field is optional.
>ExpirationDate
Expiration date for responding to the purchase quote request.
This field is optional.
>{Date}</ExpirationDate>SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 10000
>{Integer}</SupplierId>Shipment
This field is optional.
>DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
>{String}</DeliveryTerms>DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
>{String}</DeliveryTermPlace>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
This field is optional.
>{Integer}</ShippingServiceId>SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
": "{String}",Validity
This field is optional.
": {ExpirationDate
Expiration date for responding to the purchase quote request.
This field is optional.
": "{Date}"SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 10000
": "{Integer}"Shipment
This field is optional.
": {DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
": "{String}",DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
": "{String}",ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
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.
PurchaseQuoteRequestId
Purchase quote request identifier
>{Integer}</PurchaseQuoteRequestId>Status
Status of purchase quote request
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RegistrationDate
Date of registration
>{Date}</RegistrationDate>SuppliersReference
Suppliers/sellers reference. Typically a person.
>{String}</SuppliersReference>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
>{String}</Note>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>ExpirationDate
Expiration date for responding to the purchase quote request.
>{Date}</ExpirationDate>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>Firstname
Firstname/givenname if the supplier is a person
>Attention
Attention note.
>{String}</Attention>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>SupplierLink
Supplier reference
>{String}</SupplierLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalAmount
The total amount in object currency, including VAT
>{Decimal}</TotalAmount>Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>TotalAmount
The total amount in company currency, including VAT.
>{Decimal}</TotalAmount>DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
>{String}</DeliveryTerms>DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
>{String}</DeliveryTermPlace>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>{String}</Name>CarrierId
Carrier identifier
>{Integer}</CarrierId>CarrierLink
Carrier reference
>{String}</CarrierLink>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>NotificationId
Notification identifier
>{Integer}</NotificationId>Status
Status of the notification
>{Integer}</Status>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>PurchaseQuoteRequestId
Purchase quote request identifier
": "{Integer}",Status
Status of purchase quote request
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",RegistrationDate
Date of registration
": "{Date}",SuppliersReference
Suppliers/sellers reference. Typically a person.
": "{String}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
": "{String}",Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"ExpirationDate
Expiration date for responding to the purchase quote request.
": "{Date}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",Firstname
Firstname/givenname if the supplier is a person
": {Attention
Attention note.
": "{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}"SupplierLink
Supplier reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",TotalAmount
The total amount in object currency, including VAT
": "{Decimal}",Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",TotalAmount
The total amount in company currency, including VAT.
": "{Decimal}"DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
": "{String}",DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
": "{String}",ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": "{String}",CarrierId
Carrier identifier
": "{Integer}",CarrierLink
Carrier reference
": "{String}"ShippingServiceLink
Shipping service reference
": "{String}"NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
": "{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 100365 HTTP 404 | Byproduct cost link not found |
| Error 101254 HTTP 400 | Only articles with matching PARTNERID can be purchased from this supplier |
| Error 100475 HTTP 400 | Project number is mandatory on all items. |
| Error 101488 HTTP 400 | Illegal general ledger account : {0} |
| Error 105186 HTTP 400 | Postings are not allowed on control accounts. |
| Error 101490 HTTP 400 | Illegal Account {0}: This account has been blocked for {1}-documents |
| Error 101491 HTTP 400 | Illegal Account {0}: Check the account's FromPeriod and ToPeriod |
| Error 101517 HTTP 400 | Illegal Account {0}: This account require ICTDB. |
| Error 102482 HTTP 400 | Department is required for general ledger account {0} |
| Error 102483 HTTP 400 | Finance project is required for general ledger account {0} |
| Error 102484 HTTP 400 | Asset is required for general ledger account {0} |
| 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} |