API

Procurement APIs

GET procurement/suppliers/{supplierId}/key-figures?currency={currency}&dueGranularity={granularity}

Key figures for a specified supplier. Key figures give meaningful insight into the sales/finance situation of a supplier. Note that key figures can be provided in different currencies by using the currency query parameter.

HTTP method GET
URI https://api.rambase.net/procurement/suppliers/{supplierId}/key-figures?currency={currency}&dueGranularity={granularity}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierId} RamBase supplier identifier
Integer, minimum 100
Successful HTTP status code 200
API resource identifier 2251, version 7

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.

dueGranularity String, optional Granularity of due amounts

Default: 30Days
currency String, optional Currency to be used in converting key figures
$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.

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
<KeyFigures>
2
     <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
3
     <BacklogAmount
BacklogAmount

Total amount of purchase orders, excluding value added tax, that not yet has been fulfilled.

>{Decimal}</BacklogAmount>
4
     <BacklogAmountIncludingVAT
BacklogAmountIncludingVAT

Backlog amount including value added tax

>{Decimal}</BacklogAmountIncludingVAT>
5
     <Balance
Balance

Total balance for the supplier, without value added tax (VAT)

>{Decimal}</Balance>
6
     <BalanceIncludingVAT
BalanceIncludingVAT

Total balance for the supplier, including value added tax (VAT)

>{Decimal}</BalanceIncludingVAT>
7
     <OverdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

>{Decimal}</OverdueAmount>
8
     <ClaimsAmount
ClaimsAmount

Claims of the supplier

>{Decimal}</ClaimsAmount>
9
     <NotDueAmount
NotDueAmount

Total amount that is not due

>{Decimal}</NotDueAmount>
10
     <BookingYTDAmount
BookingYTDAmount

Total amount of order received this year (to current date)

>{Decimal}</BookingYTDAmount>
11
     <BillingYTDAmount
BillingYTDAmount

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

>{Decimal}</BillingYTDAmount>
12
     <BillingByYear
BillingByYear

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

>
13
          <Billing
Billing

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

>
14
               <Year
Year

Year of billing

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

>{Integer}</Year>
15
               <BillingAmount
BillingAmount

Billing amount by year

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

>{Decimal}</BillingAmount>
16
          </Billing>
17
     </BillingByYear>
18
     <DueAmountsByGranularity
DueAmountsByGranularity

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

>
19
          <DueAmountByGranularity
DueAmountByGranularity

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

>
20
               <Currency
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=DueAmountsByGranularity in your request URI to get this field

>{String}</Currency>
21
               <FromDate
FromDate

Starting date of granularity

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

>{Date}</FromDate>
22
               <ToDate
ToDate

Ending date of granularity

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

>{Date}</ToDate>
23
               <DueAmount
DueAmount

Due amount for speicific granuality range

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

>{Decimal}</DueAmount>
24
          </DueAmountByGranularity>
25
     </DueAmountsByGranularity>
26
</KeyFigures>
1
{
2
     "keyFigures": {
3
          "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
4
          "backlogAmount
BacklogAmount

Total amount of purchase orders, excluding value added tax, that not yet has been fulfilled.

": "{Decimal}",
5
          "backlogAmountIncludingVAT
BacklogAmountIncludingVAT

Backlog amount including value added tax

": "{Decimal}",
6
          "balance
Balance

Total balance for the supplier, without value added tax (VAT)

": "{Decimal}",
7
          "balanceIncludingVAT
BalanceIncludingVAT

Total balance for the supplier, including value added tax (VAT)

": "{Decimal}",
8
          "overdueAmount
OverdueAmount

Total amount of unpaid invoices which has passed due date

": "{Decimal}",
9
          "claimsAmount
ClaimsAmount

Claims of the supplier

": "{Decimal}",
10
          "notDueAmount
NotDueAmount

Total amount that is not due

": "{Decimal}",
11
          "bookingYTDAmount
BookingYTDAmount

Total amount of order received this year (to current date)

": "{Decimal}",
12
          "billingYTDAmount
BillingYTDAmount

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

": "{Decimal}",
13
          "billingByYear
BillingByYear

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

": [
14
               {
15
                    "year
Year

Year of billing

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

": "{Integer}",
16
                    "billingAmount
BillingAmount

Billing amount by year

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

": "{Decimal}"
17
               }
18
          ],
19
          "dueAmountsByGranularity
DueAmountsByGranularity

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

": [
20
               {
21
                    "currency
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=DueAmountsByGranularity in your request URI to get this field

": "{String}",
22
                    "fromDate
FromDate

Starting date of granularity

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

": "{Date}",
23
                    "toDate
ToDate

Ending date of granularity

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

": "{Date}",
24
                    "dueAmount
DueAmount

Due amount for speicific granuality range

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

": "{Decimal}"
25
               }
26
          ]
27
     }
28
}

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 100184 HTTP 404 Accounting period not found
Error 101420 HTTP 404 Setting definition not found