API

Sales APIs

GET sales/contracts

Gets a list of sales contracts

HTTP method GET
URI https://api.rambase.net/sales/contracts
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3915, version 9

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
1

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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

Active() Named filter Active contracts
Discontinued() Named filter Discontinued contracts
New() Named filter New contracts
BackupResponsibleId Integer Employee identifier. Available macros: currentUser()
Category Integer The category of the contract. Examples: Recurring sales, One-off sales and Consulting services.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerFirstName String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
EffectiveDate Date The start of the customer sales contract. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExpirationDate Date The end of the customer sales contract. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
MainResponsibleId Integer Employee identifier. Available macros: currentUser()
SalesContractId Integer Customer sales contract identifier.
Status Integer The current status of a customer sales contract.
Title String The title of the customer sales contract.

Read more about filters and sorting on how to use sortable parameters

BackupResponsibleId Integer Employee identifier
Category Integer The category of the contract. Examples: Recurring sales, One-off sales and Consulting services
CreatedAt Datetime Date and time of creation
CustomerFirstName String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
EffectiveDate Date The start of the customer sales contract
ExpirationDate Date The end of the customer sales contract
MainResponsibleId Integer Employee identifier
SalesContractId Integer Customer sales contract identifier
Status Integer The current status of a customer sales contract
Title String The title of the customer sales contract

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
<SalesContracts>
2
     <SalesContract>
3
          <SalesContractId
SalesContractId

Customer sales contract identifier

>{Integer}</SalesContractId>
4
          <Status
Status

The current status of a customer sales contract

Possible domain values can be found here

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <Title
Title

The title of the customer sales contract

>{String}</Title>
7
          <Customer>
8
               <CustomerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

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

Secondary name of a company or firstname of a person

>{String}</FirstName>
11
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
12
          </Customer>
13
          <Validity>
14
               <EffectiveDate
EffectiveDate

The start of the customer sales contract

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

The end of the customer sales contract

>{Date}</ExpirationDate>
16
          </Validity>
17
          <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 greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

>
18
               <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

>{Integer}</EmployeeId>
19
               <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

>{String}</FirstName>
20
               <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

>{String}</LastName>
21
               <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

>{String}</EmployeeLink>
22
          </MainResponsible>
23
          <SalesContractLink
SalesContractLink

Customer sales contract reference

>{String}</SalesContractLink>
24
     </SalesContract>
25
     <Paging
Paging

Detailed paging information for this list.

>
26
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
27
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
28
          <Page
Page

Page index

>{Integer}</Page>
29
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
30
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
31
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
32
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
33
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
34
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
35
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
36
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
37
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
38
     </Paging>
39
</SalesContracts>
1
{
2
     "salesContracts": [
3
          {
4
               "salesContractId
SalesContractId

Customer sales contract identifier

": "{Integer}",
5
               "status
Status

The current status of a customer sales contract

Possible domain values can be found here

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "title
Title

The title of the customer sales contract

": "{String}",
8
               "customer": {
9
                    "customerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
11
                    "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
12
                    "customerLink
CustomerLink

Customer reference

": "{String}"
13
               },
14
               "validity": {
15
                    "effectiveDate
EffectiveDate

The start of the customer sales contract

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

The end of the customer sales contract

": "{Date}"
17
               },
18
               "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 greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

": {
19
                    "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

": "{Integer}",
20
                    "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

": "{String}",
21
                    "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

": "{String}",
22
                    "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=SalesContract.MainResponsible in your request URI to get this field

": "{String}"
23
               },
24
               "salesContractLink
SalesContractLink

Customer sales contract reference

": "{String}"
25
          }
26
     ],
27
     "paging
Paging

Detailed paging information for this list.

": {
28
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
29
          "position
Position

Position of the first element in the list

": "{Integer}",
30
          "page
Page

Page index

": "{Integer}",
31
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
32
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
33
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
34
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
35
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
36
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
37
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
38
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
39
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
40
     }
41
}

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: