POST procurement/returns

Create a new supplier return

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

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>
2
     <Type
Type

Required/mandatory field

Type of supplier return

Applicable domain values can be found here when logged in

>
{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
     <Location
Location

This field is optional.

>
9
          <LocationId
LocationId

Location identifier

Minimum value: 1000

This field is optional.

>
{Integer}</LocationId>
10
     </Location>
11
     <Supplier
Supplier

This field is optional.

>
12
          <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

>
{Integer}</SupplierId>
13
     </Supplier>
14
     <ShippingAddress
ShippingAddress

This field is optional.

>
15
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>
{Integer}</AddressId>
16
     </ShippingAddress>
17
     <Shipment
Shipment

This field is optional.

>
18
          <Priority
Priority

Priority of the shipment

Applicable domain values can be found here when logged in

This field is optional.

>
{Integer}</Priority>
19
          <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>
20
          <ShippingService
ShippingService

This field is optional.

>
21
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>
{Integer}</ShippingServiceId>
22
          </ShippingService>
23
     </Shipment>
24
</SupplierReturn>
1
{
2
     "supplierReturn": {
3
          "type
Type

Required/mandatory field

Type of supplier return

Applicable domain values can be found here when logged in

":
"{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
          "location
Location

This field is optional.

":
{
10
               "locationId
LocationId

Location identifier

Minimum value: 1000

This field is optional.

":
"{Integer}"
11
          },
12
          "supplier
Supplier

This field is optional.

":
{
13
               "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 10000

This field is optional.

":
"{Integer}"
14
          },
15
          "shippingAddress
ShippingAddress

This field is optional.

":
{
16
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

":
"{Integer}"
17
          },
18
          "shipment
Shipment

This field is optional.

":
{
19
               "priority
Priority

Priority of the shipment

Applicable domain values can be found here when logged in

This field is optional.

":
"{Integer}",
20
               "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}",
21
               "shippingService
ShippingService

This field is optional.

":
{
22
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

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

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.

$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$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.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SupplierReturn>
2
     <SupplierReturnId
SupplierReturnId

Supplier return identifier

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

Status of supplier return

Possible domain values can be found here when logged in

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

Type of supplier return

Possible domain values can be found here when logged in

>
{String}</Type>
5
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
6
     <ShippingDate
ShippingDate

Date of shipment departure

>
{Date}</ShippingDate>
7
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

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

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

>
{String}</Note>
10
     <NetWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

>
{Decimal}</NetWeight>
11
     <Currency
Currency

Three character code following the ISO 4217 standard.

Possible domain values can be found here when logged in

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

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

>
{String}</ShippingAddressAttention>
13
     <Assignee
Assignee

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

>
14
          <UserId
UserId

User identifier

>
{Integer}</UserId>
15
          <Name
Name

Name of the user

>
{String}</Name>
16
          <FirstName
FirstName

First name of the user

>
{String}</FirstName>
17
          <UserLink
UserLink

User reference

>
{String}</UserLink>
18
     </Assignee>
19
     <Location>
20
          <LocationId
LocationId

Location identifier

>
{Integer}</LocationId>
21
          <Name
Name

Name of location

>
{String}</Name>
22
          <ShortName
ShortName

Unique abbreviation/short name of the location

>
{String}</ShortName>
23
          <LocationLink
LocationLink

Location reference

>
{String}</LocationLink>
24
     </Location>
25
     <Supplier>
26
          <SupplierId
SupplierId

RamBase supplier identifier

>
{Integer}</SupplierId>
27
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
28
          <FirstName
FirstName

Firstname/givenname if the supplier is a person

>
29
               <DefaultInvoiceAddress>
30
                    <AddressId
AddressId

Address identifier

>
{Integer}</AddressId>
31
                    <Attention
Attention

Attention note.

>
{String}</Attention>
32
                    <AddressLine1
AddressLine1

First address line

>
{String}</AddressLine1>
33
                    <AddressLine2
AddressLine2

Second address line

>
{String}</AddressLine2>
34
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>
{String}</PostalCode>
35
                    <City
City

City/town/village

>
{String}</City>
36
                    <Region
Region

Region/province/state

>
{String}</Region>
37
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>
{String}</CountryCode>
38
                    <Country
Country

English name of country.

>
{String}</Country>
39
                    <AddressLink
AddressLink

Address reference

>
{String}</AddressLink>
40
               </DefaultInvoiceAddress>
41
          </FirstName>
42
          <SupplierLink
SupplierLink

Supplier reference

>
{String}</SupplierLink>
43
     </Supplier>
44
     <Totals>
45
          <Currency
Currency

Three character code following the ISO 4217 standard.

Possible domain values can be found here when logged in

>
{String}</Currency>
46
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

>
{Decimal}</FreightAmount>
47
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>
{Decimal}</TotalAmount>
48
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

>
{String}</Currency>
49
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion.

>
{Decimal}</ExchangeRate>
50
          <FreightAmount
FreightAmount

Freight amount in company currency.

>
{Decimal}</FreightAmount>
51
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

>
{Decimal}</TotalAmount>
52
     </Totals>
53
     <ShippingAddress>
54
          <AddressId
AddressId

Address identifier

>
{Integer}</AddressId>
55
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>
{String}</Name>
56
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>
{String}</Firstname>
57
          <AddressLine1
AddressLine1

First address line

>
{String}</AddressLine1>
58
          <AddressLine2
AddressLine2

Second address line

>
{String}</AddressLine2>
59
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>
{String}</PostalCode>
60
          <City
City

City/town/village

>
{String}</City>
61
          <Region
Region

Region/province/state

>
{String}</Region>
62
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>
{String}</CountryCode>
63
          <Country
Country

English name of country.

>
{String}</Country>
64
          <AddressLink
AddressLink

Address reference

>
{String}</AddressLink>
65
     </ShippingAddress>
66
     <Shipment>
67
          <Priority
Priority

Priority of the shipment

Possible domain values can be found here when logged in

>
{Integer}</Priority>
68
          <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.

Possible domain values can be found here when logged in

>
{String}</DeliveryTerms>
69
          <DepartingShipment>
70
               <ShipmentId
ShipmentId

Shipment identifier

>
{Long}</ShipmentId>
71
               <DepartingWaybill>
72
                    <DepartingWaybillId
DepartingWaybillId

Departing waybill identifier

>
{Integer}</DepartingWaybillId>
73
                    <DepartingWaybillLink
DepartingWaybillLink

Departing waybill reference

>
{String}</DepartingWaybillLink>
74
               </DepartingWaybill>
75
               <ShipmentLink
ShipmentLink

Shipment reference

>
{String}</ShipmentLink>
76
          </DepartingShipment>
77
          <ShippingService>
78
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>
{Integer}</ShippingServiceId>
79
               <Name
Name

Name of shipping service

>
{String}</Name>
80
               <Carrier>
81
                    <CarrierId
CarrierId

Carrier identifier

>
{Integer}</CarrierId>
82
                    <CarrierLink
CarrierLink

Carrier reference

>
{String}</CarrierLink>
83
               </Carrier>
84
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>
{String}</ShippingServiceLink>
85
          </ShippingService>
86
     </Shipment>
87
     <Payment>
88
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Possible domain values can be found here when logged in

>
{String}</PaymentTerms>
89
          <NotificationId
NotificationId

Notification identifier

>
{Integer}</NotificationId>
90
          <Status
Status

Status of the notification

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

Date and time of creation

>
{Datetime}</CreatedAt>
92
          <Message
Message

The message from the notification definition, expanded with parameters.

>
{String}</Message>
93
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

>
{String}</TranslatedMessage>
94
          <NotificationType>
95
               <NotificationTypeId
NotificationTypeId

Notification type identifier

>
{String}</NotificationTypeId>
96
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here when logged in

>
{String}</Category>
97
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

>
{String}</NotificationTypeLink>
98
          </NotificationType>
99
          <NotificationLink
NotificationLink

Notification reference

>
{String}</NotificationLink>
100
     </Payment>
101
</SupplierReturn>
1
{
2
     "supplierReturn": {
3
          "supplierReturnId
SupplierReturnId

Supplier return identifier

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

Status of supplier return

Possible domain values can be found here when logged in

":
"{Integer}",
5
          "type
Type

Type of supplier return

Possible domain values can be found here when logged in

":
"{String}",
6
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
7
          "shippingDate
ShippingDate

Date of shipment departure

":
"{Date}",
8
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

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

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

":
"{String}",
11
          "netWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

":
"{Decimal}",
12
          "currency
Currency

Three character code following the ISO 4217 standard.

Possible domain values can be found here when logged in

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

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

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

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

":
{
15
               "userId
UserId

User identifier

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

Name of the user

":
"{String}",
17
               "firstName
FirstName

First name of the user

":
"{String}",
18
               "userLink
UserLink

User reference

":
"{String}"
19
          },
20
          "location": {
21
               "locationId
LocationId

Location identifier

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

Name of location

":
"{String}",
23
               "shortName
ShortName

Unique abbreviation/short name of the location

":
"{String}",
24
               "locationLink
LocationLink

Location reference

":
"{String}"
25
          },
26
          "supplier": {
27
               "supplierId
SupplierId

RamBase supplier identifier

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

Name of supplier (name of company or surname/familyname/lastname of a person)

":
"{String}",
29
               "firstName
FirstName

Firstname/givenname if the supplier is a person

":
{
30
                    "defaultInvoiceAddress": {
31
                         "addressId
AddressId

Address identifier

":
"{Integer}",
32
                         "attention
Attention

Attention note.

":
"{String}",
33
                         "addressLine1
AddressLine1

First address line

":
"{String}",
34
                         "addressLine2
AddressLine2

Second address line

":
"{String}",
35
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

":
"{String}",
36
                         "city
City

City/town/village

":
"{String}",
37
                         "region
Region

Region/province/state

":
"{String}",
38
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

":
"{String}",
39
                         "country
Country

English name of country.

":
"{String}",
40
                         "addressLink
AddressLink

Address reference

":
"{String}"
41
                    }
42
               },
43
               "supplierLink
SupplierLink

Supplier reference

":
"{String}"
44
          },
45
          "totals": {
46
               "currency
Currency

Three character code following the ISO 4217 standard.

Possible domain values can be found here when logged in

":
"{String}",
47
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

":
"{Decimal}",
48
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

":
"{Decimal}",
49
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

":
"{String}",
50
               "exchangeRate
ExchangeRate

The exchange rate used in convertion.

":
"{Decimal}",
51
               "freightAmount
FreightAmount

Freight amount in company currency.

":
"{Decimal}",
52
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

":
"{Decimal}"
53
          },
54
          "shippingAddress": {
55
               "addressId
AddressId

Address identifier

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

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

":
"{String}",
57
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

":
"{String}",
58
               "addressLine1
AddressLine1

First address line

":
"{String}",
59
               "addressLine2
AddressLine2

Second address line

":
"{String}",
60
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

":
"{String}",
61
               "city
City

City/town/village

":
"{String}",
62
               "region
Region

Region/province/state

":
"{String}",
63
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

":
"{String}",
64
               "country
Country

English name of country.

":
"{String}",
65
               "addressLink
AddressLink

Address reference

":
"{String}"
66
          },
67
          "shipment": {
68
               "priority
Priority

Priority of the shipment

Possible domain values can be found here when logged in

":
"{Integer}",
69
               "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.

Possible domain values can be found here when logged in

":
"{String}",
70
               "departingShipment": {
71
                    "shipmentId
ShipmentId

Shipment identifier

":
"{Long}",
72
                    "departingWaybill": {
73
                         "departingWaybillId
DepartingWaybillId

Departing waybill identifier

":
"{Integer}",
74
                         "departingWaybillLink
DepartingWaybillLink

Departing waybill reference

":
"{String}"
75
                    },
76
                    "shipmentLink
ShipmentLink

Shipment reference

":
"{String}"
77
               },
78
               "shippingService": {
79
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

":
"{String}",
81
                    "carrier": {
82
                         "carrierId
CarrierId

Carrier identifier

":
"{Integer}",
83
                         "carrierLink
CarrierLink

Carrier reference

":
"{String}"
84
                    },
85
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

":
"{String}"
86
               }
87
          },
88
          "payment": {
89
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Possible domain values can be found here when logged in

":
"{String}",
90
               "notificationId
NotificationId

Notification identifier

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

Status of the notification

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

Date and time of creation

":
"{Datetime}",
93
               "message
Message

The message from the notification definition, expanded with parameters.

":
"{String}",
94
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

":
"{String}",
95
               "notificationType": {
96
                    "notificationTypeId
NotificationTypeId

Notification type identifier

":
"{String}",
97
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here when logged in

":
"{String}",
98
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

":
"{String}"
99
               },
100
               "notificationLink
NotificationLink

Notification reference

":
"{String}"
101
          }
102
     }
103
}

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: