API

Procurement APIs

PUT procurement/quotes/{purchaseQuoteId}

Purchase quote details for provided identifier

HTTP method PUT
URI https://api.rambase.net/procurement/quotes/{purchaseQuoteId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseQuoteId} Purchase quote identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2861, version 8

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.

Format:
1
<PurchaseQuote
PurchaseQuote

This field is optional.

>
2
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

>{String}</SuppliersReference>
3
     <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers reference number. Typically to an external system.

This field is optional.

>{String}</SuppliersReferenceNumber>
4
     <Currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

>{String}</Currency>
5
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
6
     <Assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

>
7
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
8
     </Assignee>
9
     <Validity
Validity

This field is optional.

>
10
          <EffectiveDate
EffectiveDate

The date the purchase quote takes effect. The quote will be effective from and including this date.

This field is optional.

>{Date}</EffectiveDate>
11
          <ExpirationDate
ExpirationDate

The date the purchase quote expires. The quote will be active to and including this date.

This field is optional.

>{Date}</ExpirationDate>
12
     </Validity>
13
     <Supplier
Supplier

This field is optional.

>
14
          <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

>{Integer}</SupplierId>
15
     </Supplier>
16
     <Shipment
Shipment

This field is optional.

>
17
          <DeliveryTerms
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>
18
          <DeliveryTermPlace
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>
19
          <ShippingService
ShippingService

This field is optional.

>
20
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
21
          </ShippingService>
22
     </Shipment>
23
     <Payment
Payment

This field is optional.

>
24
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Applicable domain values can be found here

This field is optional.

>{String}</PaymentTerms>
25
     </Payment>
26
</PurchaseQuote>
1
{
2
     "purchaseQuote
PurchaseQuote

This field is optional.

": {
3
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

": "{String}",
4
          "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers reference number. Typically to an external system.

This field is optional.

": "{String}",
5
          "currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

": "{String}",
6
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

": "{String}",
7
          "assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

": {
8
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
9
          },
10
          "validity
Validity

This field is optional.

": {
11
               "effectiveDate
EffectiveDate

The date the purchase quote takes effect. The quote will be effective from and including this date.

This field is optional.

": "{Date}",
12
               "expirationDate
ExpirationDate

The date the purchase quote expires. The quote will be active to and including this date.

This field is optional.

": "{Date}"
13
          },
14
          "supplier
Supplier

This field is optional.

": {
15
               "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
16
          },
17
          "shipment
Shipment

This field is optional.

": {
18
               "deliveryTerms
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}",
19
               "deliveryTermPlace
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}",
20
               "shippingService
ShippingService

This field is optional.

": {
21
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
22
               }
23
          },
24
          "payment
Payment

This field is optional.

": {
25
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Applicable domain values can be found here

This field is optional.

": "{String}"
26
          }
27
     }
28
}

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.
$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.

Format:
1
1

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 100202 HTTP 404 Payable journal entry not found
Error 102750 HTTP 400 Number of parameter values does not match the number of parameters in the formula
Error 102749 HTTP 400 Missing parameter value for parameter {0}
Error 102747 HTTP 400 Error in formula: {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 102486 HTTP 400 Invalid value for dimension {0}