API

Procurement APIs

PUT procurement/credit-notes/{supplierCreditNoteId}/items/{itemId}

Stores information about supplier credit note item. All amounts should be in the currency of the supplier invoice.

HTTP method PUT
URI https://api.rambase.net/procurement/credit-notes/{supplierCreditNoteId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierCreditNoteId} Supplier credit note identifier
Integer, minimum 100000
- URI parameter {itemId} Item-/linenumber of supplier credit note
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4331, version 3

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

This field is optional.

>
2
     <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

This field is optional.

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

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

This field is optional.

>{String}</ProductDescription>
4
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
5
     <Quantity
Quantity

Quantity of supplier credit note item

This field is optional.

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

This field is optional.

>
7
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

This field is optional.

>{Decimal}</NetPrice>
8
     </Price>
9
     <Product
Product

This field is optional.

>
10
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
11
     </Product>
12
     <Accounting
Accounting

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

This field is optional.

>
13
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
14
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
15
          </VATCodeDefinition>
16
     </Accounting>
17
     <ProjectOrderItem
ProjectOrderItem

This field is optional.

>
18
          <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

Minimum value: 1

This field is optional.

>{Integer}</ProjectOrderItemId>
19
          <ProjectOrder
ProjectOrder

This field is optional.

>
20
               <ProjectOrderId
ProjectOrderId

Project order identifier

Minimum value: 100000

This field is optional.

>{Integer}</ProjectOrderId>
21
          </ProjectOrder>
22
     </ProjectOrderItem>
23
</SupplierCreditNoteItem>
1
{
2
     "supplierCreditNoteItem
SupplierCreditNoteItem

This field is optional.

": {
3
          "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

This field is optional.

": "{String}",
4
          "productDescription
ProductDescription

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

This field is optional.

": "{String}",
5
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

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

Quantity of supplier credit note item

This field is optional.

": "{Decimal}",
7
          "price
Price

This field is optional.

": {
8
               "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

This field is optional.

": "{Decimal}"
9
          },
10
          "product
Product

This field is optional.

": {
11
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
12
          },
13
          "accounting
Accounting

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

This field is optional.

": {
14
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
15
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
16
               }
17
          },
18
          "projectOrderItem
ProjectOrderItem

This field is optional.

": {
19
               "projectOrderItemId
ProjectOrderItemId

Project order item identifier

Minimum value: 1

This field is optional.

": "{Integer}",
20
               "projectOrder
ProjectOrder

This field is optional.

": {
21
                    "projectOrderId
ProjectOrderId

Project order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
22
               }
23
          }
24
     }
25
}

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.
$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. 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
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 102733 HTTP 400 Formula can not be empty
Error 102750 HTTP 400 Number of parameter values does not match the number of parameters in the formula
Error 102749 HTTP 400 Missing parameter value for parameter {0}
Error 102747 HTTP 400 Error in formula: {0}
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 101047 HTTP 400 The purchase quote item has too low available quantity
Error 101400 HTTP 400 Supplier credit claim has been created from shipping advice
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 102486 HTTP 400 Invalid value for dimension {0}