API

Procurement APIs

POST procurement/invoices/{supplierInvoiceId}/items

Creates a new item in provided supplier invoice

HTTP method POST
URI https://api.rambase.net/procurement/invoices/{supplierInvoiceId}/items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierInvoiceId} Supplier invoice identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 4202, version 2

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
<SupplierInvoiceItem>
2
     <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

This field is optional.

>{String}</ProductDescription>
3
     <Quantity
Quantity

Required/mandatory field

Quantity of supplier invoice item

>{Decimal}</Quantity>
4
     <Product>
5
          <ProductId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

>{Integer}</ProductId>
6
     </Product>
7
     <Price>
8
          <NetPrice
NetPrice

Required/mandatory field

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
9
     </Price>
10
     <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

>
11
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
12
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
13
          </VATCodeDefinition>
14
          <GeneralLedgerAccount
GeneralLedgerAccount

This field is optional.

>
15
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

>{Integer}</GeneralLedgerAccountId>
16
          </GeneralLedgerAccount>
17
          <Department
Department

The department related to the item. One of the system/fixed account dimensions.

This field is optional.

>
18
               <DepartmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

>{Integer}</DepartmentId>
19
          </Department>
20
          <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

This field is optional.

>
21
               <FinanceProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

>{Integer}</FinanceProjectId>
22
          </FinanceProject>
23
          <Asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

This field is optional.

>
24
               <AssetId
AssetId

Asset identifier

Minimum value: 1

This field is optional.

>{Integer}</AssetId>
25
          </Asset>
26
     </Accounting>
27
</SupplierInvoiceItem>
1
{
2
     "supplierInvoiceItem": {
3
          "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

This field is optional.

": "{String}",
4
          "quantity
Quantity

Required/mandatory field

Quantity of supplier invoice item

": "{Decimal}",
5
          "product": {
6
               "productId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

": "{Integer}"
7
          },
8
          "price": {
9
               "netPrice
NetPrice

Required/mandatory field

Final price per unit after deducting all discounts etc.

": "{Decimal}"
10
          },
11
          "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

": {
12
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
13
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
14
               },
15
               "generalLedgerAccount
GeneralLedgerAccount

This field is optional.

": {
16
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
17
               },
18
               "department
Department

The department related to the item. One of the system/fixed account dimensions.

This field is optional.

": {
19
                    "departmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

": "{Integer}"
20
               },
21
               "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

This field is optional.

": {
22
                    "financeProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

": "{Integer}"
23
               },
24
               "asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

This field is optional.

": {
25
                    "assetId
AssetId

Asset identifier

Minimum value: 1

This field is optional.

": "{Integer}"
26
               }
27
          }
28
     }
29
}

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 101198 HTTP 404 Sales quote item not found
Error 102229 HTTP 400 Location {0} is already defined on the product
Error 106562 HTTP 400 This product is blocked for sale
Error 106563 HTTP 400 This product is blocked for shipping
Error 100199 HTTP 404 Location is not found
Error 101490 HTTP 400 Illegal Account {0}: This account has been blocked for {1}-documents
Error 101491 HTTP 400 Illegal Account {0}: Check the account's FromPeriod and ToPeriod
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 109539 HTTP 400 Dimension value {0} could not be used : Check its FromPeriod and ToPeriod.
Error 102486 HTTP 400 Invalid value for dimension {0}