PUT procurement/returns/{supplierReturnId}

Update details of provided supplier return

Note: Log in to check if your API client have access to run this resource
Version: 7
Success HTTP Status Code: 200

Uri parameters

{supplierReturnId} Integer Supplier return identifier

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 is required/mandatory.

Format:
1
<SupplierReturn
SupplierReturn

This field is optional.

>
2
     <Type
Type

Type of supplier return

Applicable domain values can be found here when logged in

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 when logged in

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

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

This field is optional.

>
9
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>
{Integer}</UserId>
10
     </Assignee>
11
     <Location
Location

This field is optional.

>
12
          <LocationId
LocationId

Location identifier

Minimum value: 1000

This field is optional.

>
{Integer}</LocationId>
13
     </Location>
14
     <Supplier
Supplier

This field is optional.

>
15
          <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

>
{Integer}</SupplierId>
16
     </Supplier>
17
     <Totals
Totals

This field is optional.

>
18
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

>
{Decimal}</FreightAmount>
19
     </Totals>
20
     <ShippingAddress
ShippingAddress

This field is optional.

>
21
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>
{Integer}</AddressId>
22
     </ShippingAddress>
23
     <Shipment
Shipment

This field is optional.

>
24
          <Priority
Priority

Priority of the shipment

Applicable domain values can be found here when logged in

This field is optional.

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

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Applicable domain values can be found here when logged in

This field is optional.

>
{String}</DeliveryTerms>
26
          <ShippingService
ShippingService

This field is optional.

>
27
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>
{Integer}</ShippingServiceId>
28
          </ShippingService>
29
     </Shipment>
30
</SupplierReturn>
1
{
2
     "supplierReturn
SupplierReturn

This field is optional.

":
{
3
          "type
Type

Type of supplier return

Applicable domain values can be found here when logged in

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 when logged in

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
          "assignee
Assignee

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

This field is optional.

":
{
10
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
11
          },
12
          "location
Location

This field is optional.

":
{
13
               "locationId
LocationId

Location identifier

Minimum value: 1000

This field is optional.

":
"{Integer}"
14
          },
15
          "supplier
Supplier

This field is optional.

":
{
16
               "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

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

This field is optional.

":
{
19
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

Minimum value: 0

This field is optional.

":
"{Decimal}"
20
          },
21
          "shippingAddress
ShippingAddress

This field is optional.

":
{
22
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

":
"{Integer}"
23
          },
24
          "shipment
Shipment

This field is optional.

":
{
25
               "priority
Priority

Priority of the shipment

Applicable domain values can be found here when logged in

This field is optional.

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

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Applicable domain values can be found here when logged in

This field is optional.

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

This field is optional.

":
{
28
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
29
               }
30
          }
31
     }
32
}

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.

$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page 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: