API

Sales APIs

POST sales/customers/{customerId}/output-control

Add a new output condition to the customers output control

HTTP method POST
URI https://api.rambase.net/sales/customers/{customerId}/output-control
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {customerId} Customer identifier
Integer, minimum 10000
Successful HTTP status code 201
API resource identifier 2205, version 7

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
<OutputCondition>
2
     <OutputBy
OutputBy

Required/mandatory field

Output type

Applicable domain values can be found here

>{String}</OutputBy>
3
     <IsMandatory
IsMandatory

True if output is mandatory, and cannot be removed from the output object

Default value: False

This field is optional.

>{Boolean}</IsMandatory>
4
     <NumberOfCopies
NumberOfCopies

Number of copies to output

Minimum value: 0

Maximum value: 99

This field is optional.

>{Integer}</NumberOfCopies>
5
     <OutputObjectDefinition>
6
          <OutputObjectDefinitionId
OutputObjectDefinitionId

Required/mandatory field

Output object definition identifier

Minimum value: 10000

>{Integer}</OutputObjectDefinitionId>
7
     </OutputObjectDefinition>
8
     <OutputDesign
OutputDesign

This field is optional.

>
9
          <OutputDesignId
OutputDesignId

Output design identifier

Minimum value: 100000

This field is optional.

>{Integer}</OutputDesignId>
10
     </OutputDesign>
11
     <Recipient
Recipient

The destination of the output

This field is optional.

>
12
          <Reference
Reference

This field is optional.

>
13
               <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
14
               <ObjectId
ObjectId

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
15
               <ItemId
ItemId

Item-number of the object

This field is optional.

>{Integer}</ItemId>
16
               <ItemType
ItemType

Type of item

This field is optional.

>{String}</ItemType>
17
          </Reference>
18
     </Recipient>
19
</OutputCondition>
1
{
2
     "outputCondition": {
3
          "outputBy
OutputBy

Required/mandatory field

Output type

Applicable domain values can be found here

": "{String}",
4
          "isMandatory
IsMandatory

True if output is mandatory, and cannot be removed from the output object

Default value: False

This field is optional.

": "{Boolean}",
5
          "numberOfCopies
NumberOfCopies

Number of copies to output

Minimum value: 0

Maximum value: 99

This field is optional.

": "{Integer}",
6
          "outputObjectDefinition": {
7
               "outputObjectDefinitionId
OutputObjectDefinitionId

Required/mandatory field

Output object definition identifier

Minimum value: 10000

": "{Integer}"
8
          },
9
          "outputDesign
OutputDesign

This field is optional.

": {
10
               "outputDesignId
OutputDesignId

Output design identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
11
          },
12
          "recipient
Recipient

The destination of the output

This field is optional.

": {
13
               "reference
Reference

This field is optional.

": {
14
                    "objectType
ObjectType

Type of object

This field is optional.

": "{String}",
15
                    "objectId
ObjectId

Identifier of the object

This field is optional.

": "{Integer}",
16
                    "itemId
ItemId

Item-number of the object

This field is optional.

": "{Integer}",
17
                    "itemType
ItemType

Type of item

This field is optional.

": "{String}"
18
               }
19
          }
20
     }
21
}

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.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

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

Format:
1
<OutputCondition>
2
     <OutputConditionId
OutputConditionId

Output condition identifier

>{Integer}</OutputConditionId>
3
     <OutputBy
OutputBy

Output type

Possible domain values can be found here

>{String}</OutputBy>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <IsMandatory
IsMandatory

True if output is mandatory, and cannot be removed from the output object

>{Boolean}</IsMandatory>
6
     <NumberOfCopies
NumberOfCopies

Number of copies to output

>{Integer}</NumberOfCopies>
7
     <OutputObjectDefinition>
8
          <OutputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

>{Integer}</OutputObjectDefinitionId>
9
          <Name
Name

Name of the Output Object

>{String}</Name>
10
          <Description
Description

Description of the Output Object Definition

>{String}</Description>
11
          <OutputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

>{String}</OutputObjectDefinitionLink>
12
     </OutputObjectDefinition>
13
     <OutputDesign>
14
          <OutputDesignId
OutputDesignId

Output design identifier

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

Name of the output design

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

Output design reference

>{String}</OutputDesignLink>
17
     </OutputDesign>
18
     <Recipient
Recipient

The destination of the output

>
19
          <Details
Details

Details of recipient. Ex. the email address when output by is EMAIL.

>{String}</Details>
20
          <Reference>
21
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
22
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
23
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
24
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
25
               <ItemType
ItemType

Type of item

>{String}</ItemType>
26
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
27
          </Reference>
28
     </Recipient>
29
</OutputCondition>
1
{
2
     "outputCondition": {
3
          "outputConditionId
OutputConditionId

Output condition identifier

": "{Integer}",
4
          "outputBy
OutputBy

Output type

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "isMandatory
IsMandatory

True if output is mandatory, and cannot be removed from the output object

": "{Boolean}",
7
          "numberOfCopies
NumberOfCopies

Number of copies to output

": "{Integer}",
8
          "outputObjectDefinition": {
9
               "outputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

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

Name of the Output Object

": "{String}",
11
               "description
Description

Description of the Output Object Definition

": "{String}",
12
               "outputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

": "{String}"
13
          },
14
          "outputDesign": {
15
               "outputDesignId
OutputDesignId

Output design identifier

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

Name of the output design

": "{String}",
17
               "outputDesignLink
OutputDesignLink

Output design reference

": "{String}"
18
          },
19
          "recipient
Recipient

The destination of the output

": {
20
               "details
Details

Details of recipient. Ex. the email address when output by is EMAIL.

": "{String}",
21
               "reference": {
22
                    "objectType
ObjectType

Type of object

": "{String}",
23
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
24
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
25
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
26
                    "itemType
ItemType

Type of item

": "{String}",
27
                    "itemLink
ItemLink

API reference to the item

": "{String}"
28
               }
29
          }
30
     }
31
}

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 101015 HTTP 404 Permission not found
Error 101376 HTTP 400 ShippingService is not active (status 4)
Error 101375 HTTP 400 Direction of the Shipping Service mismatch with type of transaction document
Error 101399 HTTP 400 Customer account in shipping service mismatch with this customer account
Error 101385 HTTP 400 The carrier that offers this shipping service is not activ (status 4)
Error 100936 HTTP 400 Default invoice- and shipping address is required