API

Procurement APIs

GET procurement/quotes/{purchaseQuoteId}

Purchase quote details for provided identifier

HTTP method GET
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 603, version 23

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
1

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.

Format:
1
<PurchaseQuote>
2
     <PurchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

>{Integer}</PurchaseQuoteId>
3
     <Status
Status

Status of purchase quote

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

>{String}</SuppliersReferenceNumber>
7
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
8
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
9
     <IsShipAndDebit
IsShipAndDebit

True if purchase quote is ship and debit

>{Boolean}</IsShipAndDebit>
10
     <Note
Note

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

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

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

>
12
          <UserId
UserId

User identifier

>{Integer}</UserId>
13
          <Name
Name

Name of the user

>{String}</Name>
14
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
15
          <UserLink
UserLink

User reference

>{String}</UserLink>
16
     </Assignee>
17
     <Validity>
18
          <EffectiveDate
EffectiveDate

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

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

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

>{Date}</ExpirationDate>
20
     </Validity>
21
     <Supplier>
22
          <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
23
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
24
          <Firstname
Firstname

Firstname/givenname if the supplier is a person

>{String}</Firstname>
25
          <Phone
Phone

Main phone number of the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Phone in your request URI to get this field

>{String}</Phone>
26
          <Email
Email

Main email address to the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Email in your request URI to get this field

>{String}</Email>
27
          <Invoicing
Invoicing

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>
28
               <DefaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>
29
                    <Attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Attention>
30
                    <AddressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</AddressLine1>
31
                    <AddressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</AddressLine2>
32
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</PostalCode>
33
                    <City
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</City>
34
                    <Region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Region>
35
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</CountryCode>
36
                    <Country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

>{String}</Country>
37
               </DefaultInvoiceAddress>
38
          </Invoicing>
39
          <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
40
     </Supplier>
41
     <Totals>
42
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
43
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
44
     </Totals>
45
     <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>
46
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{String}</Currency>
47
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
48
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
49
     </TotalsConverted>
50
     <Shipment>
51
          <DeliveryTerms
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>
52
          <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

>{String}</DeliveryTermPlace>
53
          <ShippingService>
54
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
55
               <Name
Name

Name of shipping service

>{String}</Name>
56
               <Carrier>
57
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
58
                    <Name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier.Name in your request URI to get this field

>{String}</Name>
59
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
60
               </Carrier>
61
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
62
          </ShippingService>
63
     </Shipment>
64
     <Payment>
65
          <PaymentTerms
PaymentTerms

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

Possible domain values can be found here

>{String}</PaymentTerms>
66
     </Payment>
67
     <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
68
          <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</NotificationId>
69
          <Status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</Status>
70
          <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Datetime}</CreatedAt>
71
          <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Message>
72
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</TranslatedMessage>
73
          <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
74
               <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeId>
75
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Category>
76
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeLink>
77
          </NotificationType>
78
          <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationLink>
79
     </HighlightedNotification>
80
</PurchaseQuote>
1
{
2
     "purchaseQuote": {
3
          "purchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

": "{Integer}",
4
          "status
Status

Status of purchase quote

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

": "{String}",
8
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
9
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
10
          "isShipAndDebit
IsShipAndDebit

True if purchase quote is ship and debit

": "{Boolean}",
11
          "note
Note

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

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

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

": {
13
               "userId
UserId

User identifier

": "{Integer}",
14
               "name
Name

Name of the user

": "{String}",
15
               "firstName
FirstName

First name of the user

": "{String}",
16
               "userLink
UserLink

User reference

": "{String}"
17
          },
18
          "validity": {
19
               "effectiveDate
EffectiveDate

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

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

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

": "{Date}"
21
          },
22
          "supplier": {
23
               "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
24
               "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
25
               "firstname
Firstname

Firstname/givenname if the supplier is a person

": "{String}",
26
               "phone
Phone

Main phone number of the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Phone in your request URI to get this field

": "{String}",
27
               "email
Email

Main email address to the supplier

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Email in your request URI to get this field

": "{String}",
28
               "invoicing
Invoicing

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": {
29
                    "defaultInvoiceAddress
DefaultInvoiceAddress

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": {
30
                         "attention
Attention

Attention note.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
31
                         "addressLine1
AddressLine1

First address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
32
                         "addressLine2
AddressLine2

Second address line

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
33
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
34
                         "city
City

City/town/village

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
35
                         "region
Region

Region/province/state

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
36
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}",
37
                         "country
Country

English name of country.

This field is greyed out because it is an expandable field. You have to add $expand=Supplier.Invoicing in your request URI to get this field

": "{String}"
38
                    }
39
               },
40
               "supplierLink
SupplierLink

Supplier reference

": "{String}"
41
          },
42
          "totals": {
43
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
44
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}"
45
          },
46
          "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": {
47
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{String}",
48
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
49
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}"
50
          },
51
          "shipment": {
52
               "deliveryTerms
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}",
53
               "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

": "{String}",
54
               "shippingService": {
55
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
56
                    "name
Name

Name of shipping service

": "{String}",
57
                    "carrier": {
58
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
59
                         "name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier.Name in your request URI to get this field

": "{String}",
60
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
61
                    },
62
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
63
               }
64
          },
65
          "payment": {
66
               "paymentTerms
PaymentTerms

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

Possible domain values can be found here

": "{String}"
67
          },
68
          "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
69
               "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
70
               "status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
71
               "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Datetime}",
72
               "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
73
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
74
               "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
75
                    "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
76
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
77
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
78
               },
79
               "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
80
          }
81
     }
82
}

Possible error codes the response might return:

Error 100147 HTTP 404 Notification type not found
Error 100053 HTTP 403 You have only admittance to your own suppliers