API

Procurement APIs

PUT procurement/returns/{supplierReturnId}

Update details of provided supplier return

HTTP method PUT
URI https://api.rambase.net/procurement/returns/{supplierReturnId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierReturnId} Supplier return identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3230, version 11

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

This field is optional.

>
2
     <Type
Type

Type of supplier return

Applicable domain values can be found here

This field is optional.

>{String}</Type>
3
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

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

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

This field is optional.

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

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
6
     <Currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

>{String}</Currency>
7
     <ShippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

This field is optional.

>{String}</ShippingAddressAttention>
8
     <ShippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$

This field is optional.

>{String}</ShippingAddressPhone>
9
     <ShippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

>{String}</ShippingAddressEmail>
10
     <Assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

>
11
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
12
     </Assignee>
13
     <Location
Location

This field is optional.

>
14
          <LocationId
LocationId

Location identifier

Minimum value: 1000

This field is optional.

>{Integer}</LocationId>
15
     </Location>
16
     <Supplier
Supplier

This field is optional.

>
17
          <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

>{Integer}</SupplierId>
18
     </Supplier>
19
     <Totals
Totals

This field is optional.

>
20
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

>{Decimal}</FreightAmount>
21
     </Totals>
22
     <ShippingAddress
ShippingAddress

This field is optional.

>
23
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
24
     </ShippingAddress>
25
     <Shipment
Shipment

This field is optional.

>
26
          <Priority
Priority

Priority of the shipment

Applicable domain values can be found here

This field is optional.

>{Integer}</Priority>
27
          <DeliveryTerms
DeliveryTerms

Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Applicable domain values can be found here

This field is optional.

>{String}</DeliveryTerms>
28
          <DeliveryTermPlace
DeliveryTermPlace

A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye

This field is optional.

>{String}</DeliveryTermPlace>
29
          <ShippingService
ShippingService

This field is optional.

>
30
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
31
          </ShippingService>
32
     </Shipment>
33
</SupplierReturn>
1
{
2
     "supplierReturn
SupplierReturn

This field is optional.

": {
3
          "type
Type

Type of supplier return

Applicable domain values can be found here

This field is optional.

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

Suppliers/sellers reference. Typically a person.

This field is optional.

": "{String}",
5
          "suppliersReferenceNumber
SuppliersReferenceNumber

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

This field is optional.

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

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

": "{String}",
7
          "currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

": "{String}",
8
          "shippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

This field is optional.

": "{String}",
9
          "shippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$

This field is optional.

": "{String}",
10
          "shippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

This field is optional.

": "{String}",
11
          "assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

": {
12
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
13
          },
14
          "location
Location

This field is optional.

": {
15
               "locationId
LocationId

Location identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
16
          },
17
          "supplier
Supplier

This field is optional.

": {
18
               "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
19
          },
20
          "totals
Totals

This field is optional.

": {
21
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

": "{Decimal}"
22
          },
23
          "shippingAddress
ShippingAddress

This field is optional.

": {
24
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
25
          },
26
          "shipment
Shipment

This field is optional.

": {
27
               "priority
Priority

Priority of the shipment

Applicable domain values can be found here

This field is optional.

": "{Integer}",
28
               "deliveryTerms
DeliveryTerms

Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Applicable domain values can be found here

This field is optional.

": "{String}",
29
               "deliveryTermPlace
DeliveryTermPlace

A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye

This field is optional.

": "{String}",
30
               "shippingService
ShippingService

This field is optional.

": {
31
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
32
               }
33
          }
34
     }
35
}

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 103840 HTTP 400 Recalculation failed. Wrong document type.
Error 103837 HTTP 400 Recalculation failed. Missing product id.
Error 103838 HTTP 400 Recalculation failed. Missing location.
Error 101069 HTTP 404 Stock assignment link - document not found
Error 108717 HTTP 400 Base date of rental contract is required
Error 100345 HTTP 400 Location is required
Error 108514 HTTP 400 Invalid invoice frequency
Error 102035 HTTP 400 Effective date is required
Error 108421 HTTP 400 The effective date cannot be later than the expiration date
Error 108635 HTTP 400 Effective date cannot be later then effective date of any contract item
Error 108735 HTTP 400 Expiration date of a contract cannot be earlier then expiration date of any of its quotes
Error 108674 HTTP 400 Termination date cannot be earlier then the effective date
Error 108675 HTTP 400 Termination date cannot be later then the expiration date
Error 108672 HTTP 400 Closing date cannot be earlier then the effective date
Error 108673 HTTP 400 Closing date cannot be later then the expiration date
Error 108969 HTTP 400 The selected default check-out location ({0}) is not active
Error 108970 HTTP 400 The selected default check-out location ({0}) is not a rental depot capable location
Error 108971 HTTP 400 The selected default check-in location ({0}) is not active
Error 108972 HTTP 400 The selected default check-in location ({0}) is not a rental depot capable location
Error 109335 HTTP 400 Selected payment term is not supported on rental contract
Error 108670 HTTP 400 Discount percentage must be a number between 0 and 100
Error 109623 HTTP 400 VAT handling can't be changed since there has been made invoice(s) from this contract
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}
Error 108691 HTTP 400 Recurring rate is not active
Error 108018 HTTP 400 Currency mismatch
Error 108016 HTTP 400 Product id mismatch
Error 108824 HTTP 400 Cannot apply recurring rate as it is not valid for selected period
Error 109556 HTTP 400 Effective date can not be earlier than quote's expiration date
Error 108671 HTTP 400 The effective date cannot be changed because earlier days have already been invoiced
Error 108684 HTTP 400 The expiration date cannot be changed because later days have already been invoiced
Error 108683 HTTP 400 Termination date must be earlier then the expiration date
Error 109306 HTTP 400 Shipping details can only be updated until an item is shipped
Error 109467 HTTP 400 The rental unit is not available to non-owners for the selected period
Error 109315 HTTP 400 Rental unit is not available within given period