API

Procurement APIs

GET procurement/suppliers

List of suppliers

HTTP method GET
URI https://api.rambase.net/procurement/suppliers
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 313, version 26

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active supplier, but not processed yet.
Closed() Named filter Closed suppliers
NewActiveSuppliers() Named filter Suppliers who are new and active
PendingRegistration() Named filter Suppliers who are not yet registered
WithOverdueInvoices() Named filter Suppliers with unpaid invoices which have passed due date
BillingYTDAmount Decimal Total amount of invoices and credit notes that has been invoiced this year (to current date).
Classification String Classification of the supplier.
Country String English name of country.
CreatedBy Integer Employee identifier. Available macros: currentUser()
ExternalReference String External supplier reference/identifier. Can be used in external systems.
FirstName String Firstname/givenname if the supplier is a person.
GlobalLocationNumber String Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.
InternalNote String Internal note/notice of the supplier. Should not be visible to the supplier.
LegalEntityIdentifier String The suppliers unique enterprise/organization number.
Name String Name of supplier (name of company or surname/familyname/lastname of a person).
OverdueAmount Decimal Total amount of unpaid invoices which has passed due date.
Status Integer Status of the supplier. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete.
SupplierId Integer RamBase supplier identifier.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

Read more about filters and sorting on how to use sortable parameters

BillingYTDAmount Decimal Total amount of invoices and credit notes that has been invoiced this year (to current date)
Classification String Classification of the supplier
Country String English name of country.
CreatedBy Integer Employee identifier
ExternalReference String External supplier reference/identifier. Can be used in external systems
FirstName String Firstname/givenname if the supplier is a person
GlobalLocationNumber String Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.
InternalNote String Internal note/notice of the supplier. Should not be visible to the supplier.
LegalEntityIdentifier String The suppliers unique enterprise/organization number.
Name String Name of supplier (name of company or surname/familyname/lastname of a person)
OverdueAmount Decimal Total amount of unpaid invoices which has passed due date
Status Integer Status of the supplier. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete
SupplierId Integer RamBase supplier identifier
UpdatedAt Datetime Date and time of update
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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
<Suppliers>
2
     <Supplier>
3
          <SupplierId
SupplierId

RamBase supplier identifier

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

Status of the supplier. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

Possible domain values can be found here

>{Integer}</Status>
5
          <FirstName
FirstName

Firstname/givenname if the supplier is a person

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

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

>{String}</Name>
7
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
8
          <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
9
          <InternalNote
InternalNote

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

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

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

>{String}</ExternalReference>
11
          <Classification
Classification

Classification of the supplier

Possible domain values can be found here

>{String}</Classification>
12
          <VATRegistrationNumber
VATRegistrationNumber

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

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

The suppliers unique enterprise/organization number.

>{String}</LegalEntityIdentifier>
14
          <Accounting>
15
               <BillingYTDAmount
BillingYTDAmount

Total amount of invoices and credit notes that has been invoiced this year (to current date)

>{Decimal}</BillingYTDAmount>
16
          </Accounting>
17
          <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

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

>
19
                    <AddressId
AddressId

Address identifier

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

>{Integer}</AddressId>
20
                    <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>
21
                    <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>
22
                    <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>
23
                    <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>
24
                    <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>
25
                    <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>
26
                    <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>
27
                    <AddressLink
AddressLink

Supplier address reference

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}</AddressLink>
28
               </DefaultInvoiceAddress>
29
          </Invoicing>
30
          <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
31
     </Supplier>
32
     <Paging
Paging

Detailed paging information for this list.

>
33
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
34
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
35
          <Page
Page

Page index

>{Integer}</Page>
36
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
37
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
38
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
39
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
40
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
41
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
42
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
43
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
44
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
45
     </Paging>
46
</Suppliers>
1
{
2
     "suppliers": [
3
          {
4
               "supplierId
SupplierId

RamBase supplier identifier

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

Status of the supplier. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

Possible domain values can be found here

": "{Integer}",
6
               "firstName
FirstName

Firstname/givenname if the supplier is a person

": "{String}",
7
               "name
Name

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

": "{String}",
8
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
9
               "updatedAt
UpdatedAt

Date and time of update

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

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

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

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

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

Classification of the supplier

Possible domain values can be found here

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

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

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

The suppliers unique enterprise/organization number.

": "{String}",
15
               "accounting": {
16
                    "billingYTDAmount
BillingYTDAmount

Total amount of invoices and credit notes that has been invoiced this year (to current date)

": "{Decimal}"
17
               },
18
               "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

": {
19
                    "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

": {
20
                         "addressId
AddressId

Address identifier

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

": "{Integer}",
21
                         "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}",
22
                         "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}",
23
                         "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}",
24
                         "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}",
25
                         "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}",
26
                         "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}",
27
                         "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}",
28
                         "addressLink
AddressLink

Supplier address reference

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}"
29
                    }
30
               },
31
               "supplierLink
SupplierLink

Supplier reference

": "{String}"
32
          }
33
     ],
34
     "paging
Paging

Detailed paging information for this list.

": {
35
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
36
          "position
Position

Position of the first element in the list

": "{Integer}",
37
          "page
Page

Page index

": "{Integer}",
38
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
39
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
40
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
41
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
42
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
43
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
44
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
45
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
46
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
47
     }
48
}

Possible error codes the response might return:

Error 100050 HTTP 403 No admittance as customer {0}