API

Procurement APIs

POST procurement/suppliers

Creates a new supplier

HTTP method POST
URI https://api.rambase.net/procurement/suppliers
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 3626, version 9

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>
2
     <Name
Name

Required/mandatory field

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

>{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
     <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>
7
     <ExternalReference
ExternalReference

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

This field is optional.

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

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

This field is optional.

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

The suppliers unique enterprise/organization number.

This field is optional.

>{String}</LegalEntityIdentifier>
10
     <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>
11
     <Currencies
Currencies

Currencies used by the supplier

This field is optional.

>
12
          <Currency
Currency

This field is optional.

>
13
               <CurrencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

>{String}</CurrencyCode>
14
          </Currency>
15
     </Currencies>
16
     <Procurement
Procurement

This field is optional.

>
17
          <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>
18
          <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>
19
     </Procurement>
20
     <Shipment
Shipment

This field is optional.

>
21
          <SpecialHandling
SpecialHandling

Special handling for departing shipments (to this supplier)

This field is optional.

>
22
               <SpecialHandlingId
SpecialHandlingId

Special handling identifier

Minimum value: 100000

This field is optional.

>{Integer}</SpecialHandlingId>
23
          </SpecialHandling>
24
     </Shipment>
25
     <Payment
Payment

This field is optional.

>
26
          <PaymentTerms
PaymentTerms

Default payment terms to use in new documents.

Applicable domain values can be found here

This field is optional.

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

Default payment method for the supplier

Applicable domain values can be found here

This field is optional.

>{String}</PaymentMethod>
28
     </Payment>
29
</Supplier>
1
{
2
     "supplier": {
3
          "name
Name

Required/mandatory field

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

": "{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
          "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}",
8
          "externalReference
ExternalReference

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

This field is optional.

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

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

This field is optional.

": "{String}",
10
          "legalEntityIdentifier
LegalEntityIdentifier

The suppliers unique enterprise/organization number.

This field is optional.

": "{String}",
11
          "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}",
12
          "currencies
Currencies

Currencies used by the supplier

This field is optional.

": [
13
               {
14
                    "currencyCode
CurrencyCode

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

": "{String}"
15
               }
16
          ],
17
          "procurement
Procurement

This field is optional.

": {
18
               "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}",
19
               "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}"
20
          },
21
          "shipment
Shipment

This field is optional.

": {
22
               "specialHandling
SpecialHandling

Special handling for departing shipments (to this supplier)

This field is optional.

": {
23
                    "specialHandlingId
SpecialHandlingId

Special handling identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
24
               }
25
          },
26
          "payment
Payment

This field is optional.

": {
27
               "paymentTerms
PaymentTerms

Default payment terms to use in new documents.

Applicable domain values can be found here

This field is optional.

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

Default payment method for the supplier

Applicable domain values can be found here

This field is optional.

": "{String}"
29
          }
30
     }
31
}

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

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 102667 HTTP 404 Customer group not found
Error 100865 HTTP 404 Customer not found
Error 101958 HTTP 400 Recipient not found
Error 102061 HTTP 400 Contact Id is not valid for this supplier
Error 102060 HTTP 400 Supplier ID is not valid for this output condition
Error 108670 HTTP 400 Discount percentage must be a number between 0 and 100