API

Procurement APIs

POST procurement/imported-invoices/{importedSupplierInvoiceId}/items

Creats imported supplier invoice line for the provided identifier

HTTP method POST
URI https://api.rambase.net/procurement/imported-invoices/{importedSupplierInvoiceId}/items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {importedSupplierInvoiceId} Imported supplier invoice identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2819, version 5

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

This field is optional.

>
2
     <Quantity
Quantity

Quantity

This field is optional.

>{Decimal}</Quantity>
3
     <SuppliersReference
SuppliersReference

Supplier invoice line reference

This field is optional.

>{String}</SuppliersReference>
4
     <VATPercent
VATPercent

VAT percent

This field is optional.

>{Decimal}</VATPercent>
5
     <Product
Product

This field is optional.

>
6
          <Name
Name

Name of product

This field is optional.

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

An identifier or name, assigned by the supplier, for the product

This field is optional.

>{String}</SuppliersIdentification>
8
          <BuyersIdentification
BuyersIdentification

An identifier or name, assigned by the buyer, for the product

This field is optional.

>{String}</BuyersIdentification>
9
          <Description
Description

Product description

This field is optional.

>{String}</Description>
10
          <ProductReference
ProductReference

This field is optional.

>
11
               <ProductId
ProductId

RamBase product identificator

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
12
          </ProductReference>
13
     </Product>
14
     <Price
Price

This field is optional.

>
15
          <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is optional.

>{Decimal}</GrossPrice>
16
     </Price>
17
     <Totals
Totals

This field is optional.

>
18
          <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

This field is optional.

>{Decimal}</GrossAmount>
19
     </Totals>
20
</ImportedSupplierInvoiceItem>
1
{
2
     "importedSupplierInvoiceItem
ImportedSupplierInvoiceItem

This field is optional.

": {
3
          "quantity
Quantity

Quantity

This field is optional.

": "{Decimal}",
4
          "suppliersReference
SuppliersReference

Supplier invoice line reference

This field is optional.

": "{String}",
5
          "vATPercent
VATPercent

VAT percent

This field is optional.

": "{Decimal}",
6
          "product
Product

This field is optional.

": {
7
               "name
Name

Name of product

This field is optional.

": "{String}",
8
               "suppliersIdentification
SuppliersIdentification

An identifier or name, assigned by the supplier, for the product

This field is optional.

": "{String}",
9
               "buyersIdentification
BuyersIdentification

An identifier or name, assigned by the buyer, for the product

This field is optional.

": "{String}",
10
               "description
Description

Product description

This field is optional.

": "{String}",
11
               "productReference
ProductReference

This field is optional.

": {
12
                    "productId
ProductId

RamBase product identificator

Minimum value: 10000

This field is optional.

": "{Integer}"
13
               }
14
          },
15
          "price
Price

This field is optional.

": {
16
               "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is optional.

": "{Decimal}"
17
          },
18
          "totals
Totals

This field is optional.

": {
19
               "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

This field is optional.

": "{Decimal}"
20
          }
21
     }
22
}

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]

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
<ImportedSupplierInvoiceItem>
2
     <ImportedSupplierInvoiceItemId
ImportedSupplierInvoiceItemId

Identificator of the imported supplier invoice item (ISI)

>{Integer}</ImportedSupplierInvoiceItemId>
3
     <Status
Status

Status of the imported supplier invoice item

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Quantity
Quantity

Quantity

>{Decimal}</Quantity>
6
     <SuppliersReference
SuppliersReference

Supplier invoice line reference

>{String}</SuppliersReference>
7
     <VATPercent
VATPercent

VAT percent

>{Decimal}</VATPercent>
8
     <Product>
9
          <Name
Name

Name of product

>{String}</Name>
10
          <SuppliersIdentification
SuppliersIdentification

An identifier or name, assigned by the supplier, for the product

>{String}</SuppliersIdentification>
11
          <BuyersIdentification
BuyersIdentification

An identifier or name, assigned by the buyer, for the product

>{String}</BuyersIdentification>
12
          <Description
Description

Product description

>{String}</Description>
13
          <MatchingRule
MatchingRule

Rule which is used for RamBase product matching

Possible domain values can be found here

>{String}</MatchingRule>
14
          <ProductReference>
15
               <ProductId
ProductId

RamBase product identificator

>{Integer}</ProductId>
16
               <Name
Name

Name of the product

>{String}</Name>
17
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
18
          </ProductReference>
19
     </Product>
20
     <Price>
21
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
22
          <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
23
     </Price>
24
     <Totals>
25
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
26
          <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
27
     </Totals>
28
</ImportedSupplierInvoiceItem>
1
{
2
     "importedSupplierInvoiceItem": {
3
          "importedSupplierInvoiceItemId
ImportedSupplierInvoiceItemId

Identificator of the imported supplier invoice item (ISI)

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

Status of the imported supplier invoice item

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "quantity
Quantity

Quantity

": "{Decimal}",
7
          "suppliersReference
SuppliersReference

Supplier invoice line reference

": "{String}",
8
          "vATPercent
VATPercent

VAT percent

": "{Decimal}",
9
          "product": {
10
               "name
Name

Name of product

": "{String}",
11
               "suppliersIdentification
SuppliersIdentification

An identifier or name, assigned by the supplier, for the product

": "{String}",
12
               "buyersIdentification
BuyersIdentification

An identifier or name, assigned by the buyer, for the product

": "{String}",
13
               "description
Description

Product description

": "{String}",
14
               "matchingRule
MatchingRule

Rule which is used for RamBase product matching

Possible domain values can be found here

": "{String}",
15
               "productReference": {
16
                    "productId
ProductId

RamBase product identificator

": "{Integer}",
17
                    "name
Name

Name of the product

": "{String}",
18
                    "productLink
ProductLink

Product reference

": "{String}"
19
               }
20
          },
21
          "price": {
22
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
23
               "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}"
24
          },
25
          "totals": {
26
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
27
               "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}"
28
          }
29
     }
30
}

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 101079 HTTP 400 Mismatch in size of revision parameters