GET procurement/orders/{purchaseOrderId}/forward-destinations?objectType={objectType}

List of possible targets to forward purchase order to

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

Uri parameters

{purchaseOrderId} Integer Purchase order 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
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.

objectType String, optional Type of object you want to limit destinations to
$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.
$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.

ObjectId Integer Identifier of the object.
SuppliersReferenceNumber String Suppliers/sellers reference number. Typically to an external system.

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

ObjectId Integer Identifier of the object
SuppliersReferenceNumber String Suppliers/sellers reference number. Typically to an external system.

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
<ForwardDestinations>
2
     <ForwardDestination>
3
          <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
4
          <ObjectType
ObjectType

Type of object

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

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

>
{String}</SuppliersReferenceNumber>
6
          <Location>
7
               <ShortName
ShortName

Unique abbreviation/short name of the location

>
{String}</ShortName>
8
          </Location>
9
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
10
          <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
11
     </ForwardDestination>
12
</ForwardDestinations>
1
{
2
     "forwardDestinations": [
3
          {
4
               "objectId
ObjectId

Identifier of the object

":
"{Integer}",
5
               "objectType
ObjectType

Type of object

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

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

":
"{String}",
7
               "location": {
8
                    "shortName
ShortName

Unique abbreviation/short name of the location

":
"{String}"
9
               },
10
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

":
"{String}",
11
               "objectLink
ObjectLink

API reference to the object

":
"{String}"
12
          }
13
     ]
14
}

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 101832 HTTP 400 You can not do a forward operation to this object type
Error 100050 HTTP 403 No admittance as customer {0}
Error 104266 HTTP 403 Manufacturers product not found
Error 100204 HTTP 404 Manufacturer not found
Error 100089 HTTP 404 Product not found
Error 101015 HTTP 404 Permission not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 103675 HTTP 400 A purchase order can only be forwarded if it is active (status 3 or 5)
Error 103128 HTTP 400 As long as the assigned sales order is pending registration (status 1), a purchase order which is the initial direct/back to back shipment can not be forwarded.
Error 103731 HTTP 400 None of the items are allowed to be forwarded to a supplier invoice.
Error 103571 HTTP 400 A purchase order item can only be forwarded if it is active (status 3 or 5)
Error 103743 HTTP 400 This purchase order item is already pre registred on a supplier invoice.
Error 103661 HTTP 400 All quantity must be transported when reserved quantity is set
Error 103747 HTTP 400 An item for product which is not using assignments cannot be forwarded to a goods reception.
Error 100101 HTTP 404 Purchase order not found.
Error 100619 HTTP 404 Error message not found
Error 101232 HTTP 404 Purchase order item not found.
Error 103998 HTTP 400 You can't forward a higher quantity than you have serialnumbers
Error 103907 HTTP 400 Please select {0} serial numbers
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 100047 HTTP 404 Supplier not found
Error 101814 HTTP 404 Employee not found
Error 101304 HTTP 404 Carrier not found
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 100246 HTTP 404 Purchase order response not found
Error 100232 HTTP 404 Sales order not found
Error 101420 HTTP 404 Setting definition not found
Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 102120 HTTP 404 Delivery project not found
Error 100031 HTTP 404 Customer not found
Error 100009 HTTP 400 Missing required input arguments
Error 100023 HTTP 400 {0} status must be {1}
Error 101514 HTTP 400 Setting definition reference is required
Error 101708 HTTP 400 Default value is required
Error 101640 HTTP 400 Data type is required
Error 101119 HTTP 404 Shipping Service document not found
Error 102738 HTTP 404 Price list not found
Error 100048 HTTP 400 Parameter {0}: {1} not valid