Sales APIs
Output control for the provided customer. List of output conditions for handling prints, emails etc for the customer.
| HTTP method | GET |
| 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 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 2149, version 8 |
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.
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 | 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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| Email() Named filter | Send output by email |
| Mandatory() Named filter | Mandatory output control |
| Print() Named filter | Send output by print |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| IsMandatory Boolean | True if output is mandatory, and cannot be removed from the output object. |
| NumberOfCopies Integer | Number of copies to output. |
| OutputBy String | Output type. |
| OutputConditionId Integer | Output condition identifier. |
| OutputDesignId Integer | Output design identifier. |
| OutputObjectDefinitionId Integer | Output object definition identifier. |
Read more about filters and sorting on how to use sortable parameters
| CreatedAt Datetime | Date and time of creation |
| IsMandatory Boolean | True if output is mandatory, and cannot be removed from the output object |
| NumberOfCopies Integer | Number of copies to output |
| OutputBy String | Output type |
| OutputConditionId Integer | Output condition identifier |
| OutputDesignId Integer | Output design identifier |
| OutputObjectDefinitionId Integer | Output object definition identifier |
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.
OutputConditionId
Output condition identifier
>{Integer}</OutputConditionId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>IsMandatory
True if output is mandatory, and cannot be removed from the output object
>{Boolean}</IsMandatory>NumberOfCopies
Number of copies to output
>{Integer}</NumberOfCopies>OutputObjectDefinitionId
Output object definition identifier
>{Integer}</OutputObjectDefinitionId>Name
Name of the Output Object
>{String}</Name>Description
Description of the Output Object Definition
>{String}</Description>OutputObjectDefinitionLink
Output object definition reference
>{String}</OutputObjectDefinitionLink>OutputDesignId
Output design identifier
>{Integer}</OutputDesignId>Name
Name of the output design
>{String}</Name>OutputDesignLink
Output design reference
>{String}</OutputDesignLink>Recipient
The destination of the output
>Details
Details of recipient. Ex. the email address when output by is EMAIL.
>{String}</Details>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>OutputConditionLink
Output condition reference
>{String}</OutputConditionLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>OutputConditionId
Output condition identifier
": "{Integer}",OutputBy
Output type
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",IsMandatory
True if output is mandatory, and cannot be removed from the output object
": "{Boolean}",NumberOfCopies
Number of copies to output
": "{Integer}",OutputObjectDefinitionId
Output object definition identifier
": "{Integer}",Name
Name of the Output Object
": "{String}",Description
Description of the Output Object Definition
": "{String}",OutputObjectDefinitionLink
Output object definition reference
": "{String}"OutputDesignId
Output design identifier
": "{Integer}",Name
Name of the output design
": "{String}",OutputDesignLink
Output design reference
": "{String}"Recipient
The destination of the output
": {Details
Details of recipient. Ex. the email address when output by is EMAIL.
": "{String}",ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}"OutputConditionLink
Output condition reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 101114 HTTP 404 | Output object setting not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |