GET procurement/returns

List of supplier returns

Note: Log in to check if your API client have access to run this resource
Version: 10
Success HTTP Status Code: 200
Maximum items from list ($top): 80

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
1

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.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$expand String, optional Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$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.

InfoNotification() Named filter Supplier returns with notifications of category I (Information)
MySupplierReturns() Named filter Supplier returns the current user is assigned to
PendingGoods() Named filter Supplier returns pending goods (status 8)
PendingGoodsOrCredit() Named filter Supplier returns pending goods or credit (status 4)
PendingPicking() Named filter Supplier returns pending picking (status 2 )
PendingPickingQueue() Named filter Supplier returns pending to be added to picking queue (status 1)
PendingRMAFromSup() Named filter Supplier returns pending RMA from supplier (status 5)
PendingShipping() Named filter Supplier returns pending shipping (status 3)
Processed() Named filter Processed supplier returns (status 9)
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier.
CreatedAt Datetime Date and time of creation. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
DeliveryTerms String 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.
Location String Unique abbreviation/short name of the location.
Name String Name of supplier (name of company or surname/familyname/lastname of a person).
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
ShippingDate Date Date of shipment departure. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ShippingServiceId Integer Shipping service identifier.
Status Integer Status of supplier return.
SupplierId Integer RamBase supplier identifier.
SupplierReturnId Integer Supplier return identifier.
SuppliersReference String Suppliers/sellers reference. Typically a person.
SuppliersReferenceNumber String Suppliers/sellers reference number. Typically to an external system.
TotalAmount Decimal The total amount in object currency, including VAT.
Type String Type of supplier return.

See the page about filters and sorting on how to use sortable parameters

Assignee Integer The user who has been assigned to work with this object.
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard.
DeliveryTerms String 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.
Location String Unique abbreviation/short name of the location
Name String Name of supplier (name of company or surname/familyname/lastname of a person)
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
ShippingDate Date Date of shipment departure
ShippingServiceId Integer Shipping service identifier
Status Integer Status of supplier return
SupplierId Integer RamBase supplier identifier
SupplierReturnId Integer Supplier return identifier
SuppliersReference String Suppliers/sellers reference. Typically a person.
SuppliersReferenceNumber String Suppliers/sellers reference number. Typically to an external system.
TotalAmount Decimal The total amount in object currency, including VAT
Type String Type of supplier return

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
<SupplierReturns>
2
     <SupplierReturn>
3
          <SupplierReturnId
SupplierReturnId

Supplier return identifier

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

Status of supplier return

Possible domain values can be found here when logged in

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

Type of supplier return

Possible domain values can be found here when logged in

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

Date and time of creation

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

Date of shipment departure

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

Suppliers/sellers reference. Typically a person.

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

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

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

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

>
11
               <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>
{String}</UserLink>
15
          </Assignee>
16
          <Location>
17
               <LocationId
LocationId

Location identifier

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

Name of location

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

Unique abbreviation/short name of the location

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

Location reference

>
{String}</LocationLink>
21
          </Location>
22
          <Supplier>
23
               <SupplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

>
{String}</FirstName>
26
               <SupplierLink
SupplierLink

Supplier reference

>
{String}</SupplierLink>
27
          </Supplier>
28
          <Totals>
29
               <Currency
Currency

Three character code following the ISO 4217 standard.

Possible domain values can be found here when logged in

>
{String}</Currency>
30
               <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>
{Decimal}</TotalAmount>
31
          </Totals>
32
          <Shipment>
33
               <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>
34
               <ShippingService>
35
                    <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

>
{String}</Name>
37
                    <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>
{String}</ShippingServiceLink>
38
               </ShippingService>
39
          </Shipment>
40
          <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

>
41
               <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

>
{String}</TranslatedMessage>
46
               <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

>
47
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Category of notification type (warning, information etc)

Possible domain values can be found here when logged in

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

>
{String}</NotificationTypeLink>
50
               </NotificationType>
51
               <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

>
{String}</NotificationLink>
52
          </HighlightedNotification>
53
          <SupplierReturnLink
SupplierReturnLink

Supplier return reference

>
{String}</SupplierReturnLink>
54
     </SupplierReturn>
55
</SupplierReturns>
1
{
2
     "supplierReturns": [
3
          {
4
               "supplierReturnId
SupplierReturnId

Supplier return identifier

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

Status of supplier return

Possible domain values can be found here when logged in

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

Type of supplier return

Possible domain values can be found here when logged in

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

Date and time of creation

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

Date of shipment departure

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

Suppliers/sellers reference. Typically a person.

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

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

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

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

":
{
12
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

":
"{String}"
16
               },
17
               "location": {
18
                    "locationId
LocationId

Location identifier

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

Name of location

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

Unique abbreviation/short name of the location

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

Location reference

":
"{String}"
22
               },
23
               "supplier": {
24
                    "supplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

":
"{String}",
27
                    "supplierLink
SupplierLink

Supplier reference

":
"{String}"
28
               },
29
               "totals": {
30
                    "currency
Currency

Three character code following the ISO 4217 standard.

Possible domain values can be found here when logged in

":
"{String}",
31
                    "totalAmount
TotalAmount

The total amount in object currency, including VAT

":
"{Decimal}"
32
               },
33
               "shipment": {
34
                    "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}",
35
                    "shippingService": {
36
                         "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

":
"{String}",
38
                         "shippingServiceLink
ShippingServiceLink

Shipping service reference

":
"{String}"
39
                    }
40
               },
41
               "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

":
{
42
                    "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

":
"{String}",
47
                    "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

":
{
48
                         "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Category of notification type (warning, information etc)

Possible domain values can be found here when logged in

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

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

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

":
"{String}"
51
                    },
52
                    "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierReturn.HighlightedNotification in your request URI to get this field

":
"{String}"
53
               },
54
               "supplierReturnLink
SupplierReturnLink

Supplier return reference

":
"{String}"
55
          }
56
     ]
57
}

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 100199 HTTP 404 Location not found
Error 100050 HTTP 403 No admittance as customer {0}
Error 101814 HTTP 404 Employee not found
Error 101304 HTTP 404 Carrier not found
Error 100147 HTTP 404 Notification type not found