API

Sales APIs

PUT sales/contracts/{salesContractId}

Update provided sales contract

HTTP method PUT
URI https://api.rambase.net/sales/contracts/{salesContractId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesContractId} Customer sales contract identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3890, 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.

Format:
1
<SalesContract
SalesContract

This field is optional.

>
2
     <Title
Title

The title of the customer sales contract

This field is optional.

>
{String}</Title>
3
     <Description
Description

The description of what the contract is about

This field is optional.

>
{String}</Description>
4
     <Category
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>
5
     <Customer
Customer

This field is optional.

>
6
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>
{Integer}</CustomerId>
7
     </Customer>
8
     <Contact
Contact

Link to the customers contact person

This field is optional.

>
9
          <ContactId
ContactId

Contact identifier

Minimum value: 100000

This field is optional.

>
{Integer}</ContactId>
10
     </Contact>
11
     <Validity
Validity

This field is optional.

>
12
          <EffectiveDate
EffectiveDate

The start of the customer sales contract

This field is optional.

>
{Date}</EffectiveDate>
13
          <ExpirationDate
ExpirationDate

The end of the customer sales contract

This field is optional.

>
{Date}</ExpirationDate>
14
          <IsTerminable
IsTerminable

Specifies if the contract can be teminated or not

This field is optional.

>
{Boolean}</IsTerminable>
15
          <TerminationNoticePeriod
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>
16
          <RenewalDueDays
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>
17
     </Validity>
18
     <Value
Value

This field is optional.

>
19
          <Currency
Currency

Three character code following the ISO 4217 standard

This field is optional.

>
{String}</Currency>
20
          <ValuePerPeriod
ValuePerPeriod

The monetary value per period

This field is optional.

>
{Decimal}</ValuePerPeriod>
21
          <PeriodSpecification
PeriodSpecification

The periodic schedule of the contract.
Values:
- Month = 30 days
- Week = 7 days
- Year = 365 days
- Quarter = 90 days

Applicable domain values can be found here

This field is optional.

>
{Integer}</PeriodSpecification>
22
     </Value>
23
     <MainResponsible
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.

>
24
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
25
     </MainResponsible>
26
     <BackupResponsible
BackupResponsible

Link to the PID responsible if the main responsible is not available

This field is optional.

>
27
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
28
     </BackupResponsible>
29
</SalesContract>
1
{
2
     "salesContract
SalesContract

This field is optional.

":
{
3
          "title
Title

The title of the customer sales contract

This field is optional.

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

The description of what the contract is about

This field is optional.

":
"{String}",
5
          "category
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}",
6
          "customer
Customer

This field is optional.

":
{
7
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

":
"{Integer}"
8
          },
9
          "contact
Contact

Link to the customers contact person

This field is optional.

":
{
10
               "contactId
ContactId

Contact identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
11
          },
12
          "validity
Validity

This field is optional.

":
{
13
               "effectiveDate
EffectiveDate

The start of the customer sales contract

This field is optional.

":
"{Date}",
14
               "expirationDate
ExpirationDate

The end of the customer sales contract

This field is optional.

":
"{Date}",
15
               "isTerminable
IsTerminable

Specifies if the contract can be teminated or not

This field is optional.

":
"{Boolean}",
16
               "terminationNoticePeriod
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}",
17
               "renewalDueDays
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}"
18
          },
19
          "value
Value

This field is optional.

":
{
20
               "currency
Currency

Three character code following the ISO 4217 standard

This field is optional.

":
"{String}",
21
               "valuePerPeriod
ValuePerPeriod

The monetary value per period

This field is optional.

":
"{Decimal}",
22
               "periodSpecification
PeriodSpecification

The periodic schedule of the contract.
Values:
- Month = 30 days
- Week = 7 days
- Year = 365 days
- Quarter = 90 days

Applicable domain values can be found here

This field is optional.

":
"{Integer}"
23
          },
24
          "mainResponsible
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.

":
{
25
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
26
          },
27
          "backupResponsible
BackupResponsible

Link to the PID responsible if the main responsible is not available

This field is optional.

":
{
28
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
29
          }
30
     }
31
}

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.
$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. 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
1

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 100273 HTTP 404 Account manager not found
Error 100276 HTTP 400 Invalid email format
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