Procurement APIs
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.
Name
Required/mandatory field
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Firstname/givenname if the supplier is a person
This field is optional.
>{String}</FirstName>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>Phone
Main phone number of the supplier
This field is optional.
>{String}</Phone>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>ExternalReference
External supplier reference/identifier. Can be used in external systems
This field is optional.
>{String}</ExternalReference>InternalNote
Internal note/notice of the supplier. Should not be visible to the supplier.
This field is optional.
>{String}</InternalNote>LegalEntityIdentifier
The suppliers unique enterprise/organization number.
This field is optional.
>{String}</LegalEntityIdentifier>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>Currencies
Currencies used by the supplier
This field is optional.
>Currency
This field is optional.
>CurrencyCode
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</CurrencyCode>Procurement
This field is optional.
>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>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>Shipment
This field is optional.
>SpecialHandling
Special handling for departing shipments (to this supplier)
This field is optional.
>SpecialHandlingId
Special handling identifier
Minimum value: 100000
This field is optional.
>{Integer}</SpecialHandlingId>Payment
This field is optional.
>PaymentTerms
Default payment terms to use in new documents.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>PaymentMethod
Default payment method for the supplier
Applicable domain values can be found here
This field is optional.
>{String}</PaymentMethod>Name
Required/mandatory field
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Firstname/givenname if the supplier is a person
This field is optional.
": "{String}",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}",Phone
Main phone number of the supplier
This field is optional.
": "{String}",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}",ExternalReference
External supplier reference/identifier. Can be used in external systems
This field is optional.
": "{String}",InternalNote
Internal note/notice of the supplier. Should not be visible to the supplier.
This field is optional.
": "{String}",LegalEntityIdentifier
The suppliers unique enterprise/organization number.
This field is optional.
": "{String}",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}",Currencies
Currencies used by the supplier
This field is optional.
": [CurrencyCode
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}"Procurement
This field is optional.
": {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}",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}"Shipment
This field is optional.
": {SpecialHandling
Special handling for departing shipments (to this supplier)
This field is optional.
": {SpecialHandlingId
Special handling identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Payment
This field is optional.
": {PaymentTerms
Default payment terms to use in new documents.
Applicable domain values can be found here
This field is optional.
": "{String}",PaymentMethod
Default payment method for the supplier
Applicable domain values can be found here
This field is optional.
": "{String}"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.
SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Status
Status of the supplier. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete
Possible domain values can be found here
>{Integer}</Status>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
>{String}</FirstName>PreferredLanguage
Preferred language for the supplier. Is used in prints, emails etc.
Possible domain values can be found here
>{String}</PreferredLanguage>Phone
Main phone number of the supplier
>{String}</Phone>Fax
Main fax number of the supplier
>{String}</Fax>Website
Suppliers website/homepage/webpage
>{String}</Website>Main email address to the supplier
>{String}</Email>Classification
Classification of the supplier
Possible domain values can be found here
>{String}</Classification>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>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.
>{String}</EORINumber>Code
Intercompany database the supplier belongs to.
>{String}</Code>ExternalReference
External supplier reference/identifier. Can be used in external systems
>{String}</ExternalReference>InternalNote
Internal note/notice of the supplier. Should not be visible to the supplier.
>{String}</InternalNote>IsRelatedBusinessEntity
Identify if a supplier is related business entity to the company
>{Boolean}</IsRelatedBusinessEntity>IsUsingCashMethodSettlement
Identify if a supplier is using cash method for settlements
>{Boolean}</IsUsingCashMethodSettlement>LegalEntityIdentifier
The suppliers unique enterprise/organization number.
>{String}</LegalEntityIdentifier>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>CreatedBy
The user (employee or RamBase-server) that created the supplier
>UserId
Employee identifier
>{Integer}</UserId>Name
Last name of employee
>{String}</Name>FirstName
First name of employee
>{String}</FirstName>UserLink
Employee reference
>{String}</UserLink>Currencies
Currencies used by the supplier
>CurrencyCode
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</CurrencyCode>VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Possible domain values can be found here
>{String}</VATHandling>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.
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>SpecialHandling
Special handling for departing shipments (to this supplier)
>SpecialHandlingId
Special handling identifier
>{Integer}</SpecialHandlingId>SpecialHandlingLink
Special handling code reference
>{String}</SpecialHandlingLink>ArrivingShippingService
Shipping service used for arriving shipments (from this supplier)
>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>CarrierId
Carrier identifier
>{Integer}</CarrierId>Name
Name of carrier
>{String}</Name>CarrierLink
Carrier reference
>{String}</CarrierLink>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>DepartingShippingService
Shipping services used for departing shipments (to this supplier)
>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>CarrierId
Carrier identifier
>{Integer}</CarrierId>Name
Name of carrier
>{String}</Name>CarrierLink
Carrier reference
>{String}</CarrierLink>StopAutomaticForwardOfImportedInvoices
True if automatic forwarding of ISI-documents to SIN (Supplier invoice) should be blocked
AddressId
Address identifier
>{Integer}</AddressId>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>AddressLink
Supplier address reference
>{String}</AddressLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Balance
Total balance for the supplier, without value added tax (VAT)
>{Decimal}</Balance>BalanceIncludingVAT
Total balance for the supplier, including value added tax (VAT)
>{Decimal}</BalanceIncludingVAT>BillingYTDAmount
Total amount of invoices and credit notes that has been invoiced this year (to current date)
>{Decimal}</BillingYTDAmount>OverdueAmount
Total amount of unpaid invoices which has passed due date
>{Decimal}</OverdueAmount>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>PaymentTerms
Default payment terms to use in new documents.
Possible domain values can be found here
>{String}</PaymentTerms>PaymentMethod
Default payment method for the supplier
Possible domain values can be found here
>{String}</PaymentMethod>BlockPayments
Blocked payment of supplier
>{Boolean}</BlockPayments>TotalBalance
Sum of customer and cross referenced supplier balances
>{Decimal}</TotalBalance>TotalOverdueAmount
Sum of customer and cross referenced supplier overdued amounts
>{Decimal}</TotalOverdueAmount>CustomerId
Customer identifier
>{Integer}</CustomerId>IsCompany
Indicator if a customer is private entity or a company
>{Boolean}</IsCompany>CustomerLink
Customer reference
>{String}</CustomerLink>MaximumLotRuns
Max runs for supplier auctions
>{Integer}</MaximumLotRuns>AddLotFee
Boolean value, for if supplier fee amount is going to be added
>{Boolean}</AddLotFee>SupplierId
RamBase supplier identifier
": "{Integer}",Status
Status of the supplier. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete
Possible domain values can be found here
": "{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
": "{String}",PreferredLanguage
Preferred language for the supplier. Is used in prints, emails etc.
Possible domain values can be found here
": "{String}",Phone
Main phone number of the supplier
": "{String}",Fax
Main fax number of the supplier
": "{String}",Website
Suppliers website/homepage/webpage
": "{String}",Main email address to the supplier
": "{String}",Classification
Classification of the supplier
Possible domain values can be found here
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",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.
": "{String}",Code
Intercompany database the supplier belongs to.
": "{String}"ExternalReference
External supplier reference/identifier. Can be used in external systems
": "{String}",InternalNote
Internal note/notice of the supplier. Should not be visible to the supplier.
": "{String}",IsRelatedBusinessEntity
Identify if a supplier is related business entity to the company
": "{Boolean}",IsUsingCashMethodSettlement
Identify if a supplier is using cash method for settlements
": "{Boolean}",LegalEntityIdentifier
The suppliers unique enterprise/organization number.
": "{String}",UpdatedAt
Date and time of update
": "{Datetime}",CreatedAt
Date and time of creation
": "{Datetime}",CreatedBy
The user (employee or RamBase-server) that created the supplier
": {UserId
Employee identifier
": "{Integer}",Name
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",UserLink
Employee reference
": "{String}"Currencies
Currencies used by the supplier
": [CurrencyCode
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}"VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Possible domain values can be found here
": "{String}",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.
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}",SpecialHandling
Special handling for departing shipments (to this supplier)
": {SpecialHandlingId
Special handling identifier
": "{Integer}",SpecialHandlingLink
Special handling code reference
": "{String}"ArrivingShippingService
Shipping service used for arriving shipments (from this supplier)
": {ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": {CarrierId
Carrier identifier
": "{Integer}",Name
Name of carrier
": "{String}",CarrierLink
Carrier reference
": "{String}"ShippingServiceLink
Shipping service reference
": "{String}"DepartingShippingService
Shipping services used for departing shipments (to this supplier)
": {ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": {CarrierId
Carrier identifier
": "{Integer}",Name
Name of carrier
": "{String}",CarrierLink
Carrier reference
": "{String}"StopAutomaticForwardOfImportedInvoices
True if automatic forwarding of ISI-documents to SIN (Supplier invoice) should be blocked
AddressId
Address identifier
": "{Integer}",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}",AddressLink
Supplier address reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",Balance
Total balance for the supplier, without value added tax (VAT)
": "{Decimal}",BalanceIncludingVAT
Total balance for the supplier, including value added tax (VAT)
": "{Decimal}",BillingYTDAmount
Total amount of invoices and credit notes that has been invoiced this year (to current date)
": "{Decimal}",OverdueAmount
Total amount of unpaid invoices which has passed due date
": "{Decimal}",GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"PaymentTerms
Default payment terms to use in new documents.
Possible domain values can be found here
": "{String}",PaymentMethod
Default payment method for the supplier
Possible domain values can be found here
": "{String}",BlockPayments
Blocked payment of supplier
": "{Boolean}",TotalBalance
Sum of customer and cross referenced supplier balances
": "{Decimal}",TotalOverdueAmount
Sum of customer and cross referenced supplier overdued amounts
": "{Decimal}",CustomerId
Customer identifier
": "{Integer}",IsCompany
Indicator if a customer is private entity or a company
": "{Boolean}",CustomerLink
Customer reference
": "{String}"MaximumLotRuns
Max runs for supplier auctions
": "{Integer}",AddLotFee
Boolean value, for if supplier fee amount is going to be added
": "{Boolean}"
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 100944 HTTP 400 | Mismatch between post code and city |