Sales APIs
Creates a new customer sales contract
| HTTP method | POST |
| URI | https://api.rambase.net/sales/contracts |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3883, version 6 |
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.
Title
Required/mandatory field
The title of the customer sales contract
>{String}</Title>Description
The description of what the contract is about
This field is optional.
>{String}</Description>Category
The category of the contract.
Examples: Recurring sales, One-off sales and Consulting services
Applicable domain values can be found here
This field is optional.
>{Integer}</Category>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Contact
Link to the customers contact person
This field is optional.
>ContactId
Contact identifier
Minimum value: 100000
This field is optional.
>{Integer}</ContactId>Validity
This field is optional.
>EffectiveDate
The start of the customer sales contract
This field is optional.
>{Date}</EffectiveDate>ExpirationDate
The end of the customer sales contract
This field is optional.
>{Date}</ExpirationDate>IsTerminable
Specifies if the contract can be teminated or not
Default value: False
This field is optional.
>{Boolean}</IsTerminable>TerminationNoticePeriod
The length in days of the termination period. This will not have a meaning if the contract in non-terminable
Minimum value: 0
This field is optional.
>{Integer}</TerminationNoticePeriod>RenewalDueDays
The minimum number of days before EndDate where the contract can be either cancelled (if set to automatically renew) or renewed (if set to be renewed by consent)
Minimum value: 0
This field is optional.
>{Integer}</RenewalDueDays>MainResponsible
The link to the main responsible employee. This is also the main contact point for the contract from the customers point of view
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>BackupResponsible
Link to the PID responsible if the main responsible is not available
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Title
Required/mandatory field
The title of the customer sales contract
": "{String}",Description
The description of what the contract is about
This field is optional.
": "{String}",Category
The category of the contract.
Examples: Recurring sales, One-off sales and Consulting services
Applicable domain values can be found here
This field is optional.
": "{Integer}",Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Contact
Link to the customers contact person
This field is optional.
": {ContactId
Contact identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Validity
This field is optional.
": {EffectiveDate
The start of the customer sales contract
This field is optional.
": "{Date}",ExpirationDate
The end of the customer sales contract
This field is optional.
": "{Date}",IsTerminable
Specifies if the contract can be teminated or not
Default value: False
This field is optional.
": "{Boolean}",TerminationNoticePeriod
The length in days of the termination period. This will not have a meaning if the contract in non-terminable
Minimum value: 0
This field is optional.
": "{Integer}",RenewalDueDays
The minimum number of days before EndDate where the contract can be either cancelled (if set to automatically renew) or renewed (if set to be renewed by consent)
Minimum value: 0
This field is optional.
": "{Integer}"MainResponsible
The link to the main responsible employee. This is also the main contact point for the contract from the customers point of view
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"BackupResponsible
Link to the PID responsible if the main responsible is not available
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"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] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
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.
SalesContractId
Customer sales contract identifier
>{Integer}</SalesContractId>Status
The current status of a customer sales contract
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Title
The title of the customer sales contract
>{String}</Title>Description
The description of what the contract is about
>{String}</Description>Category
The category of the contract.
Examples: Recurring sales, One-off sales and Consulting services
Possible domain values can be found here
>{Integer}</Category>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>CustomerLink
Customer reference
>{String}</CustomerLink>Contact
Link to the customers contact person
>ContactId
Contact identifier
>{Integer}</ContactId>FirstName
Firstname/givenname of the contact
>{String}</FirstName>LastName
Surname/familyname/lastname of the contact
>{String}</LastName>ContactLink
Contact reference
>{String}</ContactLink>EffectiveDate
The start of the customer sales contract
>{Date}</EffectiveDate>ExpirationDate
The end of the customer sales contract
>{Date}</ExpirationDate>IsTerminable
Specifies if the contract can be teminated or not
>{Boolean}</IsTerminable>TerminationNoticePeriod
The length in days of the termination period. This will not have a meaning if the contract in non-terminable
>{Integer}</TerminationNoticePeriod>RenewalDueDays
The minimum number of days before EndDate where the contract can be either cancelled (if set to automatically renew) or renewed (if set to be renewed by consent)
>{Integer}</RenewalDueDays>RenewalDueDate
The main and backup responsible will be alerted on this date if a notification is setup
>{Date}</RenewalDueDate>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PeriodSpecification
The periodic schedule of the contract.
Values:
- Month = 30 days
- Week = 7 days
- Year = 365 days
- Quarter = 90 days
Possible domain values can be found here
>{Integer}</PeriodSpecification>ValuePerPeriod
The monetary value per period
>{Decimal}</ValuePerPeriod>TotalValue
Total value calculated from value pr period
>{Decimal}</TotalValue>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>SalesContractId
Customer sales contract identifier
": "{Integer}",Status
The current status of a customer sales contract
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Title
The title of the customer sales contract
": "{String}",Description
The description of what the contract is about
": "{String}",Category
The category of the contract.
Examples: Recurring sales, One-off sales and Consulting services
Possible domain values can be found here
": "{Integer}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"Contact
Link to the customers contact person
": {ContactId
Contact identifier
": "{Integer}",FirstName
Firstname/givenname of the contact
": "{String}",LastName
Surname/familyname/lastname of the contact
": "{String}",ContactLink
Contact reference
": "{String}"EffectiveDate
The start of the customer sales contract
": "{Date}",ExpirationDate
The end of the customer sales contract
": "{Date}",IsTerminable
Specifies if the contract can be teminated or not
": "{Boolean}",TerminationNoticePeriod
The length in days of the termination period. This will not have a meaning if the contract in non-terminable
": "{Integer}",RenewalDueDays
The minimum number of days before EndDate where the contract can be either cancelled (if set to automatically renew) or renewed (if set to be renewed by consent)
": "{Integer}",RenewalDueDate
The main and backup responsible will be alerted on this date if a notification is setup
": "{Date}"Currency
Three character code following the ISO 4217 standard
": "{String}",PeriodSpecification
The periodic schedule of the contract.
Values:
- Month = 30 days
- Week = 7 days
- Year = 365 days
- Quarter = 90 days
Possible domain values can be found here
": "{Integer}",ValuePerPeriod
The monetary value per period
": "{Decimal}",TotalValue
Total value calculated from value pr period
": "{Decimal}",EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}",EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee 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 100209 HTTP 400 | Illegal document Id {0} |
| Error 101086 HTTP 400 | Missing required argument {0} for description |
| Error 101087 HTTP 400 | Description argument/result mismatch |
| 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 104984 HTTP 400 | Expiration date is required |
| Error 104985 HTTP 400 | Main responsible is required |
| Error 100038 HTTP 400 | Invalid language: {0} |
| Error 100200 HTTP 404 | Special handling code not found |
| Error 102751 HTTP 400 | Selected pricelist is not active |
| Error 102939 HTTP 400 | Customer can not be blocked for orders before active bids are deleted |