API

Rental APIs

POST rental/contracts

Creation of new rental contract

HTTP method POST
URI https://api.rambase.net/rental/contracts
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 5759, version 10

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
<RentalContract>
2
     <Name
Name

Required/mandatory field

Short description for the rental contract

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

Detailed description for the recurring rental contract

This field is optional.

>{String}</Description>
4
     <Currency
Currency

Required/mandatory field

Three character code following the ISO 4217 standard

Applicable domain values can be found here

>{String}</Currency>
5
     <RentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Applicable domain values can be found here

This field is optional.

>{Integer}</RentalType>
6
     <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Applicable domain values can be found here

This field is optional.

>{Integer}</InvoiceFrequency>
7
     <CreateAccountAdjustmentPlan
CreateAccountAdjustmentPlan

The control bit of a mechanism of automatic creation of periods adustments

Default value: False

This field is optional.

>{Boolean}</CreateAccountAdjustmentPlan>
8
     <BaseDate
BaseDate

A date from which invoices will start to be generated from

This field is optional.

>{Date}</BaseDate>
9
     <IsAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

Default value: False

This field is optional.

>{Boolean}</IsAutomaticallyIssued>
10
     <AdvanceInvoicing
AdvanceInvoicing

This field is optional.

>
11
          <IsInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

Default value: False

This field is optional.

>{Boolean}</IsInvoicedInAdvance>
12
          <BaseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

Minimum value: 0

This field is optional.

>{Integer}</BaseDateAdvanceDays>
13
     </AdvanceInvoicing>
14
     <Period>
15
          <EffectiveDate
EffectiveDate

Required/mandatory field

Start date for the recurring contract

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

Required/mandatory field

End date of the recurring contract

>{Date}</ExpirationDate>
17
     </Period>
18
     <Customer>
19
          <CustomerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

>{Integer}</CustomerId>
20
     </Customer>
21
     <Responsible
Responsible

PID reference of sales assistant for the contract

This field is optional.

>
22
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
23
     </Responsible>
24
     <InvoiceAddress
InvoiceAddress

This field is optional.

>
25
          <AddressId
AddressId

Reference to customer's invoice address

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
26
     </InvoiceAddress>
27
     <ShippingAddress
ShippingAddress

This field is optional.

>
28
          <AddressId
AddressId

Reference to customer's shipping address

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
29
     </ShippingAddress>
30
     <Payment
Payment

This field is optional.

>
31
          <PaymentTerms
PaymentTerms

Payment terms for rental contract

Applicable domain values can be found here

This field is optional.

>{String}</PaymentTerms>
32
     </Payment>
33
     <VATDetails
VATDetails

This field is optional.

>
34
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

>{String}</VATHandling>
35
     </VATDetails>
36
</RentalContract>
1
{
2
     "rentalContract": {
3
          "name
Name

Required/mandatory field

Short description for the rental contract

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

Detailed description for the recurring rental contract

This field is optional.

": "{String}",
5
          "currency
Currency

Required/mandatory field

Three character code following the ISO 4217 standard

Applicable domain values can be found here

": "{String}",
6
          "rentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Applicable domain values can be found here

This field is optional.

": "{Integer}",
7
          "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Applicable domain values can be found here

This field is optional.

": "{Integer}",
8
          "createAccountAdjustmentPlan
CreateAccountAdjustmentPlan

The control bit of a mechanism of automatic creation of periods adustments

Default value: False

This field is optional.

": "{Boolean}",
9
          "baseDate
BaseDate

A date from which invoices will start to be generated from

This field is optional.

": "{Date}",
10
          "isAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

Default value: False

This field is optional.

": "{Boolean}",
11
          "advanceInvoicing
AdvanceInvoicing

This field is optional.

": {
12
               "isInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

Default value: False

This field is optional.

": "{Boolean}",
13
               "baseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

Minimum value: 0

This field is optional.

": "{Integer}"
14
          },
15
          "period": {
16
               "effectiveDate
EffectiveDate

Required/mandatory field

Start date for the recurring contract

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

Required/mandatory field

End date of the recurring contract

": "{Date}"
18
          },
19
          "customer": {
20
               "customerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

": "{Integer}"
21
          },
22
          "responsible
Responsible

PID reference of sales assistant for the contract

This field is optional.

": {
23
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
24
          },
25
          "invoiceAddress
InvoiceAddress

This field is optional.

": {
26
               "addressId
AddressId

Reference to customer's invoice address

Minimum value: 1

This field is optional.

": "{Integer}"
27
          },
28
          "shippingAddress
ShippingAddress

This field is optional.

": {
29
               "addressId
AddressId

Reference to customer's shipping address

Minimum value: 1

This field is optional.

": "{Integer}"
30
          },
31
          "payment
Payment

This field is optional.

": {
32
               "paymentTerms
PaymentTerms

Payment terms for rental contract

Applicable domain values can be found here

This field is optional.

": "{String}"
33
          },
34
          "vATDetails
VATDetails

This field is optional.

": {
35
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

": "{String}"
36
          }
37
     }
38
}

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.

Format:
1
<RentalContract>
2
     <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
3
     <Status
Status

Rental contract status

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Short description for the rental contract

>{String}</Name>
6
     <Description
Description

Detailed description for the recurring rental contract

>{String}</Description>
7
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
8
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
9
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
10
     <DiscountPercentage
DiscountPercentage

This field originates from the Rental discount field on the customer. If changing this field it will not alter discount on existing items.

>{Decimal}</DiscountPercentage>
11
     <RentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Possible domain values can be found here

>{Integer}</RentalType>
12
     <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

>{Integer}</InvoiceFrequency>
13
     <CreateAccountAdjustmentPlan
CreateAccountAdjustmentPlan

The control bit of a mechanism of automatic creation of periods adustments

>{Boolean}</CreateAccountAdjustmentPlan>
14
     <DeactivateExpirationDateExtending
DeactivateExpirationDateExtending

Allows to deactivate the automatic extension of expiration dates setting for the contract

>{Boolean}</DeactivateExpirationDateExtending>
15
     <BaseDate
BaseDate

A date from which invoices will start to be generated from

>{Date}</BaseDate>
16
     <IsAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

>{Boolean}</IsAutomaticallyIssued>
17
     <ShippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

>{String}</ShippingAddressAttention>
18
     <ShippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

>{String}</ShippingAddressPhone>
19
     <ShippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

>{String}</ShippingAddressEmail>
20
     <InvoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

>
21
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
22
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
23
          <LocationLink
LocationLink

Location reference

>{Integer}</LocationLink>
24
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
25
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
26
          <LocationLink
LocationLink

Location reference

>{Integer}</LocationLink>
27
     </InvoiceAddressAttention>
28
     <AdvanceInvoicing>
29
          <IsInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

>{Boolean}</IsInvoicedInAdvance>
30
          <BaseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

>{Integer}</BaseDateAdvanceDays>
31
     </AdvanceInvoicing>
32
     <Period>
33
          <EffectiveDate
EffectiveDate

Start date for the recurring contract

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

End date of the recurring contract

>{Date}</ExpirationDate>
35
          <RegistrationDate
RegistrationDate

The date of registration of the contract

>{Date}</RegistrationDate>
36
          <TerminationDate
TerminationDate

The date of termination of the contract

>{Date}</TerminationDate>
37
          <ClosingDate
ClosingDate

The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed

>{Date}</ClosingDate>
38
     </Period>
39
     <Customer>
40
          <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

>{String}</CustomerLink>
44
     </Customer>
45
     <InvoiceAddress>
46
          <AddressId
AddressId

Reference to customer's invoice address

>{Integer}</AddressId>
47
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</FirstName>
49
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
50
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
51
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
52
          <City
City

City/town/village

>{String}</City>
53
          <Region
Region

Region/province/state

>{String}</Region>
54
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
55
          <Country
Country

English name of country.

>{String}</Country>
56
          <AddressLink
AddressLink

Address reference

>{String}</AddressLink>
57
     </InvoiceAddress>
58
     <ShippingAddress>
59
          <AddressId
AddressId

Reference to customer's shipping address

>{Integer}</AddressId>
60
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</FirstName>
62
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
63
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
64
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
65
          <City
City

City/town/village

>{String}</City>
66
          <Region
Region

Region/province/state

>{String}</Region>
67
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
68
          <Country
Country

English name of country.

>{String}</Country>
69
          <ExternalReference
ExternalReference

External address identifier. Normally defined by the customer.

>{String}</ExternalReference>
70
          <AddressLink
AddressLink

Address reference

>{String}</AddressLink>
71
     </ShippingAddress>
72
     <Responsible
Responsible

PID reference of sales assistant for the contract

>
73
          <UserId
UserId

User identifier

>{Integer}</UserId>
74
          <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
76
          <UserLink
UserLink

User reference

>{String}</UserLink>
77
     </Responsible>
78
     <Assignee
Assignee

PID reference of sales assistant for the contract

>
79
          <UserId
UserId

User identifier

>{Integer}</UserId>
80
          <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
82
          <UserLink
UserLink

User reference

>{String}</UserLink>
83
     </Assignee>
84
     <AccountManager
AccountManager

PID reference of sales assistant for the contract

>
85
          <UserId
UserId

User identifier

>{Integer}</UserId>
86
          <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
88
          <UserLink
UserLink

User reference

>{String}</UserLink>
89
     </AccountManager>
90
     <Payment>
91
          <PaymentTerms
PaymentTerms

Payment terms for rental contract

Possible domain values can be found here

>{String}</PaymentTerms>
92
     </Payment>
93
     <VATDetails>
94
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

>{String}</VATHandling>
95
     </VATDetails>
96
     <Location>
97
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
98
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
99
          <Address>
100
               <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
101
          </Address>
102
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
103
     </Location>
104
     <Shipment>
105
          <DeliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

>{String}</DeliveryTerms>
106
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
107
          <ShippingService>
108
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
109
               <Name
Name

Name of shipping service

>{String}</Name>
110
               <Carrier>
111
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
112
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
113
               </Carrier>
114
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
115
          </ShippingService>
116
     </Shipment>
117
     <Totals>
118
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
119
          <TotalAmount
TotalAmount

Total amount estimated per rental contract

>{Decimal}</TotalAmount>
120
          <DiscountAmount
DiscountAmount

Accumulated value of total discount

>{Decimal}</DiscountAmount>
121
          <TotalNetAmount
TotalNetAmount

Accumulated sum of total amounts after the discounts

>{Decimal}</TotalNetAmount>
122
          <AccruedRevenue
AccruedRevenue

Accumulated value of accrued amounts

>{Decimal}</AccruedRevenue>
123
          <InvoicedAmount
InvoicedAmount

Accumulated value of invoiced amounts

>{Decimal}</InvoicedAmount>
124
          <ForecastedRevenue
ForecastedRevenue

Accumulated value of forecasted amounts

>{Decimal}</ForecastedRevenue>
125
          <EarnedRevenue
EarnedRevenue

Accumulated value of earned revenue of all contract items

>{Decimal}</EarnedRevenue>
126
          <CountOfQuotes
CountOfQuotes

Count of items in stage quote

>{Integer}</CountOfQuotes>
127
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
128
          <TotalAmount
TotalAmount

Total amount estimated per rental contract

>{Decimal}</TotalAmount>
129
          <DiscountAmount
DiscountAmount

Accumulated value of total discount

>{Decimal}</DiscountAmount>
130
          <TotalNetAmount
TotalNetAmount

Accumulated sum of total amounts after the discounts

>{Decimal}</TotalNetAmount>
131
          <AccruedRevenue
AccruedRevenue

Accumulated value of accrued amounts

>{Decimal}</AccruedRevenue>
132
          <InvoicedAmount
InvoicedAmount

Accumulated value of invoiced amounts

>{Decimal}</InvoicedAmount>
133
          <ForecastedRevenue
ForecastedRevenue

Accumulated value of forecasted amounts

>{Decimal}</ForecastedRevenue>
134
          <EarnedRevenue
EarnedRevenue

Accumulated value of earned revenue of all contract items

>{Decimal}</EarnedRevenue>
135
     </Totals>
136
</RentalContract>
1
{
2
     "rentalContract": {
3
          "rentalContractId
RentalContractId

Rental contract identifier

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

Rental contract status

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "name
Name

Short description for the rental contract

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

Detailed description for the recurring rental contract

": "{String}",
8
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
9
          "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
10
          "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
11
          "discountPercentage
DiscountPercentage

This field originates from the Rental discount field on the customer. If changing this field it will not alter discount on existing items.

": "{Decimal}",
12
          "rentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Possible domain values can be found here

": "{Integer}",
13
          "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

": "{Integer}",
14
          "createAccountAdjustmentPlan
CreateAccountAdjustmentPlan

The control bit of a mechanism of automatic creation of periods adustments

": "{Boolean}",
15
          "deactivateExpirationDateExtending
DeactivateExpirationDateExtending

Allows to deactivate the automatic extension of expiration dates setting for the contract

": "{Boolean}",
16
          "baseDate
BaseDate

A date from which invoices will start to be generated from

": "{Date}",
17
          "isAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

": "{Boolean}",
18
          "shippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

": "{String}",
19
          "shippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

": "{String}",
20
          "shippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

": "{String}",
21
          "invoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

": {
22
               "locationId
LocationId

Location identifier

": "{Integer}",
23
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
24
               "locationLink
LocationLink

Location reference

": "{Integer}",
25
               "locationId
LocationId

Location identifier

": "{Integer}",
26
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
27
               "locationLink
LocationLink

Location reference

": "{Integer}"
28
          },
29
          "advanceInvoicing": {
30
               "isInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

": "{Boolean}",
31
               "baseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

": "{Integer}"
32
          },
33
          "period": {
34
               "effectiveDate
EffectiveDate

Start date for the recurring contract

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

End date of the recurring contract

": "{Date}",
36
               "registrationDate
RegistrationDate

The date of registration of the contract

": "{Date}",
37
               "terminationDate
TerminationDate

The date of termination of the contract

": "{Date}",
38
               "closingDate
ClosingDate

The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed

": "{Date}"
39
          },
40
          "customer": {
41
               "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
45
          },
46
          "invoiceAddress": {
47
               "addressId
AddressId

Reference to customer's invoice address

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

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
50
               "addressLine1
AddressLine1

First address line

": "{String}",
51
               "addressLine2
AddressLine2

Second address line

": "{String}",
52
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
53
               "city
City

City/town/village

": "{String}",
54
               "region
Region

Region/province/state

": "{String}",
55
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
56
               "country
Country

English name of country.

": "{String}",
57
               "addressLink
AddressLink

Address reference

": "{String}"
58
          },
59
          "shippingAddress": {
60
               "addressId
AddressId

Reference to customer's shipping address

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

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
63
               "addressLine1
AddressLine1

First address line

": "{String}",
64
               "addressLine2
AddressLine2

Second address line

": "{String}",
65
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
66
               "city
City

City/town/village

": "{String}",
67
               "region
Region

Region/province/state

": "{String}",
68
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
69
               "country
Country

English name of country.

": "{String}",
70
               "externalReference
ExternalReference

External address identifier. Normally defined by the customer.

": "{String}",
71
               "addressLink
AddressLink

Address reference

": "{String}"
72
          },
73
          "responsible
Responsible

PID reference of sales assistant for the contract

": {
74
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
77
               "userLink
UserLink

User reference

": "{String}"
78
          },
79
          "assignee
Assignee

PID reference of sales assistant for the contract

": {
80
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
83
               "userLink
UserLink

User reference

": "{String}"
84
          },
85
          "accountManager
AccountManager

PID reference of sales assistant for the contract

": {
86
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
89
               "userLink
UserLink

User reference

": "{String}"
90
          },
91
          "payment": {
92
               "paymentTerms
PaymentTerms

Payment terms for rental contract

Possible domain values can be found here

": "{String}"
93
          },
94
          "vATDetails": {
95
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

": "{String}"
96
          },
97
          "location": {
98
               "locationId
LocationId

Location identifier

": "{Integer}",
99
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
100
               "address": {
101
                    "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"
102
               },
103
               "locationLink
LocationLink

Location reference

": "{String}"
104
          },
105
          "shipment": {
106
               "deliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

": "{String}",
107
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

": "{String}",
108
               "shippingService": {
109
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}",
111
                    "carrier": {
112
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
113
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
114
                    },
115
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
116
               }
117
          },
118
          "totals": {
119
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
120
               "totalAmount
TotalAmount

Total amount estimated per rental contract

": "{Decimal}",
121
               "discountAmount
DiscountAmount

Accumulated value of total discount

": "{Decimal}",
122
               "totalNetAmount
TotalNetAmount

Accumulated sum of total amounts after the discounts

": "{Decimal}",
123
               "accruedRevenue
AccruedRevenue

Accumulated value of accrued amounts

": "{Decimal}",
124
               "invoicedAmount
InvoicedAmount

Accumulated value of invoiced amounts

": "{Decimal}",
125
               "forecastedRevenue
ForecastedRevenue

Accumulated value of forecasted amounts

": "{Decimal}",
126
               "earnedRevenue
EarnedRevenue

Accumulated value of earned revenue of all contract items

": "{Decimal}",
127
               "countOfQuotes
CountOfQuotes

Count of items in stage quote

": "{Integer}",
128
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
129
               "totalAmount
TotalAmount

Total amount estimated per rental contract

": "{Decimal}",
130
               "discountAmount
DiscountAmount

Accumulated value of total discount

": "{Decimal}",
131
               "totalNetAmount
TotalNetAmount

Accumulated sum of total amounts after the discounts

": "{Decimal}",
132
               "accruedRevenue
AccruedRevenue

Accumulated value of accrued amounts

": "{Decimal}",
133
               "invoicedAmount
InvoicedAmount

Accumulated value of invoiced amounts

": "{Decimal}",
134
               "forecastedRevenue
ForecastedRevenue

Accumulated value of forecasted amounts

": "{Decimal}",
135
               "earnedRevenue
EarnedRevenue

Accumulated value of earned revenue of all contract items

": "{Decimal}"
136
          }
137
     }
138
}

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 101420 HTTP 404 Setting definition not found
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 100018 HTTP 404 Document {0} not found
Error 106383 HTTP 400 Minimum production order quantity must be a positive number if set
Error 103546 HTTP 400 Only product structures can be blocked for production
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 109643 HTTP 400 Safetystock cannot be greater than maximumstock
Error 103478 HTTP 400 Purchase price is required
Error 102109 HTTP 400 Supplier is required
Error 100047 HTTP 404 Supplier not found
Error 101097 HTTP 404 Given currency {0} mismatch with currencies of supplier {1}
Error 103551 HTTP 400 IsManufacturedInBatches can only be changed on product structures
Error 103554 HTTP 400 AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures
Error 104253 HTTP 400 ProduceInMultipleOf can only be changed on product structures.
Error 107694 HTTP 400 Use line production can only be changed on product structeres
Error 106999 HTTP 400 Sub module 'Projectorder' is not activated in this company
Error 106436 HTTP 400 Unit can only be changed when status is equal to draft (status 1)
Error 100167 HTTP 404 Measurement unit not found
Error 104486 HTTP 400 Unit production is only allowed for measurment units (UNI) of type QTY
Error 100200 HTTP 404 Special handling code not found
Error 100092 HTTP 404 Service template not found
Error 103020 HTTP 404 Qcdoc not found
Error 101091 HTTP 404 Contry of origin is not valid: {0}
Error 101124 HTTP 400 Hardware code already exists
Error 106437 HTTP 400 Type can not be changed when status is not equal to draft (status 1)
Error 106680 HTTP 400 Not allowed when product is of subscription sales type
Error 101009 HTTP 400 The product has a structure. You can only change the product type to a type that can contain a structure.
Error 101010 HTTP 400 The product structure contains operations and can not be changed to become a phantom structure
Error 101008 HTTP 400 Cannot change product type from a physical type to a virtual type
Error 101007 HTTP 400 Cannot change product type from a virtual type to a physical type
Error 108988 HTTP 400 Sales type can not be changed when status is equal to completed(status 9)
Error 109184 HTTP 400 Sales type can not be changed to Subscription from other types.
Error 109185 HTTP 400 Sales type can not be changed to other types from Subscription.
Error 109180 HTTP 400 Sales type can not be changed from Rental/Sale to Sales
Error 103021 HTTP 400 Linkid must be a rental product
Error 104760 HTTP 400 Costing method can't be changed after product has been received
Error 104652 HTTP 400 Both minimum sales price and minimum sales price currency must be given
Error 100563 HTTP 400 Currency {0} is not supported by the system
Error 104653 HTTP 400 Minimum sales price can not be negative
Error 106506 HTTP 404 Image not found