API

Procurement APIs

PUT procurement/suppliers/{supplierId}

Saves/stores details about a supplier

HTTP method PUT
URI https://api.rambase.net/procurement/suppliers/{supplierId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierId} RamBase supplier identifier
Integer, minimum 100
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3627, version 24

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
<Supplier
Supplier

This field is optional.

>
2
     <Name
Name

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

This field is optional.

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

Firstname/givenname if the supplier is a person

This field is optional.

>{String}</FirstName>
4
     <PreferredLanguage
PreferredLanguage

Preferred language for the supplier. Is used in prints, emails etc.

Applicable domain values can be found here

Input must match the following regular expression pattern: ^[a-z]{3}$

This field is optional.

>{String}</PreferredLanguage>
5
     <Phone
Phone

Main phone number of the supplier

This field is optional.

>{String}</Phone>
6
     <Fax
Fax

Main fax number of the supplier

This field is optional.

>{String}</Fax>
7
     <Email
Email

Main email address to the supplier

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

>{String}</Email>
8
     <ExternalReference
ExternalReference

External supplier reference/identifier. Can be used in external systems

This field is optional.

>{String}</ExternalReference>
9
     <InternalNote
InternalNote

Internal note/notice of the supplier. Should not be visible to the supplier.

This field is optional.

>{String}</InternalNote>
10
     <IsRelatedBusinessEntity
IsRelatedBusinessEntity

Identify if a supplier is related business entity to the company

This field is optional.

>{Boolean}</IsRelatedBusinessEntity>
11
     <IsUsingCashMethodSettlement
IsUsingCashMethodSettlement

Identify if a supplier is using cash method for settlements

This field is optional.

>{Boolean}</IsUsingCashMethodSettlement>
12
     <LegalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

This field is optional.

>{String}</LegalEntityIdentifier>
13
     <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is optional.

>{String}</VATRegistrationNumber>
14
     <EORINumber
EORINumber

An EORI (Economic Operator Registration and Identification number) number is required of any party intending to import into the EU or export from the EU.

This field is optional.

>{String}</EORINumber>
15
     <Website
Website

Suppliers website/homepage/webpage

This field is optional.

>{String}</Website>
16
     <Classification
Classification

Classification of the supplier

Applicable domain values can be found here

This field is optional.

>{String}</Classification>
17
     <Intercompany
Intercompany

This field is optional.

>
18
          <Code
Code

Intercompany database the supplier belongs to.

This field is optional.

>{String}</Code>
19
     </Intercompany>
20
     <Currencies
Currencies

Currencies used by the supplier

This field is optional.

>
21
          <Currency
Currency

This field is optional.

>
22
               <CurrencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

>{String}</CurrencyCode>
23
          </Currency>
24
     </Currencies>
25
     <Procurement
Procurement

This field is optional.

>
26
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

>{String}</VATHandling>
27
          <ConfirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

Minimum value: 0

This field is optional.

>{Integer}</ConfirmedDeliveryDateBuffer>
28
     </Procurement>
29
     <Shipment
Shipment

This field is optional.

>
30
          <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>
31
          <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>
32
          <ArrivingShippingService
ArrivingShippingService

Shipping service used for arriving shipments (from this supplier)

This field is optional.

>
33
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
34
          </ArrivingShippingService>
35
          <DepartingShippingService
DepartingShippingService

Shipping services used for departing shipments (to this supplier)

This field is optional.

>
36
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
37
          </DepartingShippingService>
38
          <SpecialHandling
SpecialHandling

Special handling for departing shipments (to this supplier)

This field is optional.

>
39
               <SpecialHandlingId
SpecialHandlingId

Special handling identifier

Minimum value: 100000

This field is optional.

>{Integer}</SpecialHandlingId>
40
          </SpecialHandling>
41
     </Shipment>
42
     <Invoicing
Invoicing

This field is optional.

>
43
          <StopAutomaticForwardOfImportedInvoices
StopAutomaticForwardOfImportedInvoices

True if automatic forwarding of ISI-documents to SIN (Supplier invoice) should be blocked

This field is optional.

>{Boolean}</StopAutomaticForwardOfImportedInvoices>
44
     </Invoicing>
45
     <Payment
Payment

This field is optional.

>
46
          <PaymentTerms
PaymentTerms

Default payment terms to use in new documents.

Applicable domain values can be found here

This field is optional.

>{String}</PaymentTerms>
47
          <PaymentMethod
PaymentMethod

Default payment method for the supplier

Applicable domain values can be found here

This field is optional.

>{String}</PaymentMethod>
48
          <BlockPayments
BlockPayments

Blocked payment of supplier

This field is optional.

>{Boolean}</BlockPayments>
49
     </Payment>
50
     <Accounting
Accounting

This field is optional.

>
51
          <GeneralLedgerAccount
GeneralLedgerAccount

This field is optional.

>
52
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

This field is optional.

>{Integer}</GeneralLedgerAccountId>
53
          </GeneralLedgerAccount>
54
     </Accounting>
55
     <Auction
Auction

This field is optional.

>
56
          <MaximumLotRuns
MaximumLotRuns

Max runs for supplier auctions

This field is optional.

>{Integer}</MaximumLotRuns>
57
          <AddLotFee
AddLotFee

Boolean value, for if supplier fee amount is going to be added

This field is optional.

>{Boolean}</AddLotFee>
58
     </Auction>
59
</Supplier>
1
{
2
     "supplier
Supplier

This field is optional.

": {
3
          "name
Name

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

This field is optional.

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

Firstname/givenname if the supplier is a person

This field is optional.

": "{String}",
5
          "preferredLanguage
PreferredLanguage

Preferred language for the supplier. Is used in prints, emails etc.

Applicable domain values can be found here

Input must match the following regular expression pattern: ^[a-z]{3}$

This field is optional.

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

Main phone number of the supplier

This field is optional.

": "{String}",
7
          "fax
Fax

Main fax number of the supplier

This field is optional.

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

Main email address to the supplier

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

": "{String}",
9
          "externalReference
ExternalReference

External supplier reference/identifier. Can be used in external systems

This field is optional.

": "{String}",
10
          "internalNote
InternalNote

Internal note/notice of the supplier. Should not be visible to the supplier.

This field is optional.

": "{String}",
11
          "isRelatedBusinessEntity
IsRelatedBusinessEntity

Identify if a supplier is related business entity to the company

This field is optional.

": "{Boolean}",
12
          "isUsingCashMethodSettlement
IsUsingCashMethodSettlement

Identify if a supplier is using cash method for settlements

This field is optional.

": "{Boolean}",
13
          "legalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

This field is optional.

": "{String}",
14
          "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is optional.

": "{String}",
15
          "eORINumber
EORINumber

An EORI (Economic Operator Registration and Identification number) number is required of any party intending to import into the EU or export from the EU.

This field is optional.

": "{String}",
16
          "website
Website

Suppliers website/homepage/webpage

This field is optional.

": "{String}",
17
          "classification
Classification

Classification of the supplier

Applicable domain values can be found here

This field is optional.

": "{String}",
18
          "intercompany
Intercompany

This field is optional.

": {
19
               "code
Code

Intercompany database the supplier belongs to.

This field is optional.

": "{String}"
20
          },
21
          "currencies
Currencies

Currencies used by the supplier

This field is optional.

": [
22
               {
23
                    "currencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

": "{String}"
24
               }
25
          ],
26
          "procurement
Procurement

This field is optional.

": {
27
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

": "{String}",
28
               "confirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

Minimum value: 0

This field is optional.

": "{Integer}"
29
          },
30
          "shipment
Shipment

This field is optional.

": {
31
               "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}",
32
               "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}",
33
               "arrivingShippingService
ArrivingShippingService

Shipping service used for arriving shipments (from this supplier)

This field is optional.

": {
34
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
35
               },
36
               "departingShippingService
DepartingShippingService

Shipping services used for departing shipments (to this supplier)

This field is optional.

": {
37
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
38
               },
39
               "specialHandling
SpecialHandling

Special handling for departing shipments (to this supplier)

This field is optional.

": {
40
                    "specialHandlingId
SpecialHandlingId

Special handling identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
41
               }
42
          },
43
          "invoicing
Invoicing

This field is optional.

": {
44
               "stopAutomaticForwardOfImportedInvoices
StopAutomaticForwardOfImportedInvoices

True if automatic forwarding of ISI-documents to SIN (Supplier invoice) should be blocked

This field is optional.

": "{Boolean}"
45
          },
46
          "payment
Payment

This field is optional.

": {
47
               "paymentTerms
PaymentTerms

Default payment terms to use in new documents.

Applicable domain values can be found here

This field is optional.

": "{String}",
48
               "paymentMethod
PaymentMethod

Default payment method for the supplier

Applicable domain values can be found here

This field is optional.

": "{String}",
49
               "blockPayments
BlockPayments

Blocked payment of supplier

This field is optional.

": "{Boolean}"
50
          },
51
          "accounting
Accounting

This field is optional.

": {
52
               "generalLedgerAccount
GeneralLedgerAccount

This field is optional.

": {
53
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

This field is optional.

": "{Integer}"
54
               }
55
          },
56
          "auction
Auction

This field is optional.

": {
57
               "maximumLotRuns
MaximumLotRuns

Max runs for supplier auctions

This field is optional.

": "{Integer}",
58
               "addLotFee
AddLotFee

Boolean value, for if supplier fee amount is going to be added

This field is optional.

": "{Boolean}"
59
          }
60
     }
61
}

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 105170 HTTP 404 Job Sequence Extension not found
Error 105991 HTTP 400 Event is not of the same type as event set on the automated flow
Error 100012 HTTP 400 {0} must exist in {1}
Error 101399 HTTP 400 Customer account in shipping service mismatch with this customer account
Error 101385 HTTP 400 The carrier that offers this shipping service is not activ (status 4)
Error 100942 HTTP 400 External reference should be unique
Error 100944 HTTP 400 Mismatch between post code and city