Sales APIs
Creates a new notification in this sales invoice
| HTTP method | POST |
| URI | https://api.rambase.net/sales/invoices/{salesInvoiceId}/notifications |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesInvoiceId} |
Sales invoice identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 4672, version 2 |
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.
RegardingItem
This field is optional.
>ItemId
Item-number of the object
Minimum value: 1
This field is optional.
>{Integer}</ItemId>MessageParameters
Parameters used when expanding the message.
This field is optional.
>MessageParameter
This field is optional.
>Key
Key of the message parameter. Found in the message of the notification definition.
This field is optional.
>{String}</Key>Value
The value that replaces the key in the message of the notification definition.
This field is optional.
>{String}</Value>NotificationTypeId
Required/mandatory field
Notification type identifier
>{String}</NotificationTypeId>RegardingItem
This field is optional.
": {ItemId
Item-number of the object
Minimum value: 1
This field is optional.
": "{Integer}"MessageParameters
Parameters used when expanding the message.
This field is optional.
": [Key
Key of the message parameter. Found in the message of the notification definition.
This field is optional.
": "{String}",Value
The value that replaces the key in the message of the notification definition.
This field is optional.
": "{String}"NotificationTypeId
Required/mandatory field
Notification type identifier
": "{String}"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.
NotificationId
Notification identifier
>{Integer}</NotificationId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>Priority
Requested priority of the approval request.
Possible domain values can be found here
>ApprovalRuleId
Approval rule identifier
>{Integer}</ApprovalRuleId>Name
Name of the approval rule
>{String}</Name>Description
Approval rule description
>{String}</Description>SendRequestToDefaultApprovers
Send request to all approvers selected as default approvers
>{Boolean}</SendRequestToDefaultApprovers>ApprovalRuleLink
Approval rule reference
>{String}</ApprovalRuleLink>Value
Value which was approved (if approved).
>{String}</Value>Comment
Message entered by the user when requesting approval
>{String}</Comment>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>IsApproved
True if the notification needs approval, and is approved.
>{Boolean}</IsApproved>Comment
Message entered by the user when approving or denying the approval request
>{String}</Comment>ReviewedAt
Date and time of approvel.
>{Datetime}</ReviewedAt>ReviewedBy
The employee who approved the notification.
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemLink
API reference to the item
>{String}</ItemLink>MessageParameters
Parameters used when expanding the message.
>Key
Key of the message parameter. Found in the message of the notification definition.
>{String}</Key>Value
The value that replaces the key in the message of the notification definition.
>{String}</Value>CreatedBy
The user who created the notification.
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>Priority
Priority of notification with this notification type.
>{String}</Priority>ForwardNotifications
True if notifications created with this definition will be forwarded when the owner object is forwarded.
>{Boolean}</ForwardNotifications>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",Priority
Requested priority of the approval request.
Possible domain values can be found here
": {ApprovalRuleId
Approval rule identifier
": "{Integer}",Name
Name of the approval rule
": "{String}",Description
Approval rule description
": "{String}",SendRequestToDefaultApprovers
Send request to all approvers selected as default approvers
": "{Boolean}",ApprovalRuleLink
Approval rule reference
": "{String}"Value
Value which was approved (if approved).
": "{String}",Comment
Message entered by the user when requesting approval
": "{String}",EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"IsApproved
True if the notification needs approval, and is approved.
": "{Boolean}",Comment
Message entered by the user when approving or denying the approval request
": "{String}",ReviewedAt
Date and time of approvel.
": "{Datetime}",ReviewedBy
The employee who approved the notification.
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"ItemId
Item-number of the object
": "{Integer}",ItemLink
API reference to the item
": "{String}"MessageParameters
Parameters used when expanding the message.
": [Key
Key of the message parameter. Found in the message of the notification definition.
": "{String}",Value
The value that replaces the key in the message of the notification definition.
": "{String}"CreatedBy
The user who created the notification.
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",Priority
Priority of notification with this notification type.
": "{String}",ForwardNotifications
True if notifications created with this definition will be forwarded when the owner object is forwarded.
": "{Boolean}",NotificationTypeLink
Notification type reference
": "{String}"
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 101420 HTTP 404 | Setting definition not found |