API

Sales APIs

POST sales/credit-notes

Creates a new sales credit note

HTTP method POST
URI https://api.rambase.net/sales/credit-notes
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 4820, 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.

Format:
1
<SalesCreditNote>
2
     <Type
Type

Type of sales credit note

Applicable domain values can be found here

This field is optional.

>
{String}</Type>
3
     <Currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

Input must match the following regular expression pattern: ^[A-Z]{3}$

This field is optional.

>
{String}</Currency>
4
     <Customer>
5
          <CustomerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

>
{Integer}</CustomerId>
6
     </Customer>
7
</SalesCreditNote>
1
{
2
     "salesCreditNote": {
3
          "type
Type

Type of sales credit note

Applicable domain values can be found here

This field is optional.

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

Three character code following the ISO 4217 standard

Applicable domain values can be found here

Input must match the following regular expression pattern: ^[A-Z]{3}$

This field is optional.

":
"{String}",
5
          "customer": {
6
               "customerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

":
"{Integer}"
7
          }
8
     }
9
}

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
<SalesCreditNote>
2
     <SalesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

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

Status of the sales credit note

Possible domain values can be found here

>
{String}</Status>
4
     <Type
Type

Type of sales credit note

Possible domain values can be found here

>
{String}</Type>
5
     <CreatedAt
CreatedAt

Date and time of creation

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

Date when the document was issued.

>
{Date}</IssueDate>
7
     <RegistrationDate
RegistrationDate

Date of registration

>
{Date}</RegistrationDate>
8
     <SellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

>
{String}</SellersReferenceNumber>
9
     <SellersPaymentReference
SellersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

>
{String}</SellersPaymentReference>
10
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

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

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

>
{String}</CustomersReferenceNumber>
12
     <ExchangeRateFluctuationAgreement
ExchangeRateFluctuationAgreement

When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.

Possible domain values can be found here

>
{String}</ExchangeRateFluctuationAgreement>
13
     <GrossMargin
GrossMargin

Gross margin of sale, calculated as an average of gross margin of all items at the time items are created and when the document is registered. Will not be recalculated if gross margin in items change afterwards

>
{Decimal}</GrossMargin>
14
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>
{String}</Currency>
15
     <CreditReason
CreditReason

Field used to specify the reason for the credit

>
{String}</CreditReason>
16
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>
{String}</Note>
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.

>
{String}</InvoiceAddressAttention>
21
     <IncludeInDunningJobs
IncludeInDunningJobs

Indicates if a sales invoice and / or credit note is included in dunning job.

>
{Boolean}</IncludeInDunningJobs>
22
     <IncludeInInterestJobs
IncludeInInterestJobs

Indicates if a sales invoice and / or credit note is included in interest job.

>
{Boolean}</IncludeInInterestJobs>
23
     <ExternalReference
ExternalReference

External sales credit note reference/identifier. Can be used in external systems.

>
24
          <IsSubjectedToSplitPayment
IsSubjectedToSplitPayment

Indicates if an customer / supplier invoice and / or credit note is subjected to split payment

>
{Boolean}</IsSubjectedToSplitPayment>
25
          <IsInternal
IsInternal

Indicates if an customer / supplier invoice and / or credit note is marked as internal

>
{Boolean}</IsInternal>
26
          <EUSaleToNonCompany
EUSaleToNonCompany

Sales from Poland to EU country, to natural persons who do not conduct business activity (non company).

>
{Boolean}</EUSaleToNonCompany>
27
          <ThirdPartyTransactionCode
ThirdPartyTransactionCode

Transaction code used when purchasing goods in the EU by the third largest VAT payer in a triangular transaction.

Possible domain values can be found here

>
{String}</ThirdPartyTransactionCode>
28
          <IsCorrectionInvoice
IsCorrectionInvoice

Indicates if an credit note is marked as a correction invoice

>
{Boolean}</IsCorrectionInvoice>
29
     </ExternalReference>
30
     <Location>
31
          <ShortName
ShortName

Unique abbreviation/short name of the location

>
{String}</ShortName>
32
     </Location>
33
     <AccountingPeriod>
34
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>
{Integer}</AccountingPeriodId>
35
          <Period
Period

Accounting period

>
{Integer}</Period>
36
          <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>
{String}</AccountingPeriodLink>
37
     </AccountingPeriod>
38
     <Assignee
Assignee

The user who has been assigned to work with this object.

>
39
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>
{String}</UserLink>
43
     </Assignee>
44
     <Customer>
45
          <CustomerId
CustomerId

Customer identifier

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

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

>
{String}</Name>
47
          <Firstname
Firstname

Secondary name of a company or firstname of a person

>
{String}</Firstname>
48
          <LegalEntityIdentifier
LegalEntityIdentifier

The customers unique enterprise/organization number.

>
{String}</LegalEntityIdentifier>
49
          <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

>
{String}</VATRegistrationNumber>
50
          <Intercompany>
51
               <Code
Code

Intercompany database the customer belongs to.

>
{String}</Code>
52
          </Intercompany>
53
          <Sales>
54
               <SalesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>
{String}</SalesDistrict>
55
               <MarketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

>
56
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
57
                    <LastName
LastName

Last name of employee

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

First name of employee

>
{String}</FirstName>
59
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
60
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
61
                    <LastName
LastName

Last name of employee

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

First name of employee

>
{String}</FirstName>
63
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
64
               </MarketSegment>
65
          </Sales>
66
          <CustomerLegalEntity>
67
               <CustomerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

>
{Integer}</CustomerLegalEntityId>
68
               <CustomerLegalEntityLink
CustomerLegalEntityLink

Reference to customer legal entity

>
{String}</CustomerLegalEntityLink>
69
          </CustomerLegalEntity>
70
          <CustomerLink
CustomerLink

Customer reference

>
{String}</CustomerLink>
71
     </Customer>
72
     <ShippingAddress>
73
          <AddressId
AddressId

Address identifier

>
{Integer}</AddressId>
74
          <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>
75
          <Firstname
Firstname

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

>
{String}</Firstname>
76
          <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

External address identifier. Normally defined by the customer.

>
{String}</ExternalReference>
84
     </ShippingAddress>
85
     <InvoiceAddress>
86
          <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>
87
          <Firstname
Firstname

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

>
{String}</Firstname>
88
          <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>
{String}</Country>
95
     </InvoiceAddress>
96
     <Totals>
97
          <Currency
Currency

Three character code following the ISO 4217 standard

>
{String}</Currency>
98
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

>
{Decimal}</FreightAmount>
99
          <FeeAmount
FeeAmount

Fee amount in transaction document's currency

>
{Decimal}</FeeAmount>
100
          <RoundOffAmount
RoundOffAmount

Round-off amount in transaction document's currency

>
{Decimal}</RoundOffAmount>
101
          <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>
{Decimal}</SubTotalAmount>
102
          <VATAmount
VATAmount

Total value added tax in object currency.

>
{Decimal}</VATAmount>
103
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>
{Decimal}</TotalAmount>
104
          <VATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in transaction document's currency

>
{Decimal}</VATRoundOffAmount>
105
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

>
{String}</Currency>
106
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

>
{Decimal}</ExchangeRate>
107
          <FreightAmount
FreightAmount

Freight amount in company currency.

>
{Decimal}</FreightAmount>
108
          <FeeAmount
FeeAmount

Fee amount in company currency

>
{Decimal}</FeeAmount>
109
          <RoundOffAmount
RoundOffAmount

Round-off amount in company currency

>
{Decimal}</RoundOffAmount>
110
          <SubTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

>
{Decimal}</SubTotalAmount>
111
          <VATAmount
VATAmount

Value added tax amount in company currency.

>
{Decimal}</VATAmount>
112
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

>
{Decimal}</TotalAmount>
113
          <VATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in company currency

>
{Decimal}</VATRoundOffAmount>
114
     </Totals>
115
     <Shipment>
116
          <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>
117
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

>
{String}</DeliveryTermPlace>
118
          <ShippingService>
119
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

>
{String}</Name>
121
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>
{String}</ShippingServiceLink>
122
          </ShippingService>
123
     </Shipment>
124
     <Payment>
125
          <PaymentTerms
PaymentTerms

Default payment terms to use in new documents.

Possible domain values can be found here

>
{String}</PaymentTerms>
126
          <PaymentMethod
PaymentMethod

Default payment method for the customer

Possible domain values can be found here

>
{String}</PaymentMethod>
127
          <DueDate
DueDate

Date the object is due to be paid

>
{Date}</DueDate>
128
     </Payment>
129
     <VATDetails>
130
          <PostponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

>
{Boolean}</PostponeVAT>
131
          <VATType
VATType

Type of value added tax

>
{String}</VATType>
132
          <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>
133
          <VATRate
VATRate

Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.

>
{Decimal}</VATRate>
134
          <VATDate
VATDate

Date of VAT posting. Currency rate calculation use this date.

>
{Date}</VATDate>
135
          <VATPeriod
VATPeriod

Accounting period this VAT posting belongs to

>
{Integer}</VATPeriod>
136
          <DefaultVATPercent
DefaultVATPercent

Value added tax percent.

>
{Decimal}</DefaultVATPercent>
137
          <DefaultVATCodeDefinition>
138
               <VATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

>
{Integer}</VATCodeDefinitionId>
139
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>
{String}</VATCode>
140
               <Description
Description

Description of VAT Code definition

>
{String}</Description>
141
               <VATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

>
{String}</VATCodeDefinitionLink>
142
          </DefaultVATCodeDefinition>
143
          <VATEntity>
144
               <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

>
{String}</VATRegistrationNumber>
145
               <Currency
Currency

Three character code following the ISO 4217 standard

>
{String}</Currency>
146
               <Country
Country

Country name of VAT entity

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

Country code of VAT Entity

>
{String}</CountryCode>
148
          </VATEntity>
149
          <NotificationId
NotificationId

Notification identifier

>
{Integer}</NotificationId>
150
          <Status
Status

Status of the notification

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

Date and time of creation

>
{Datetime}</CreatedAt>
152
          <Message
Message

The message from the notification definition, expanded with parameters.

>
{String}</Message>
153
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

>
{String}</TranslatedMessage>
154
          <NotificationType>
155
               <NotificationTypeId
NotificationTypeId

Notification type identifier

>
{String}</NotificationTypeId>
156
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

>
{String}</Category>
157
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

>
{String}</NotificationTypeLink>
158
          </NotificationType>
159
          <NotificationLink
NotificationLink

Notification reference

>
{String}</NotificationLink>
160
     </VATDetails>
161
</SalesCreditNote>
1
{
2
     "salesCreditNote": {
3
          "salesCreditNoteId
SalesCreditNoteId

Sales credit note identifier

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

Status of the sales credit note

Possible domain values can be found here

":
"{String}",
5
          "type
Type

Type of sales credit note

Possible domain values can be found here

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

Date and time of creation

":
"{Datetime}",
7
          "issueDate
IssueDate

Date when the document was issued.

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

Date of registration

":
"{Date}",
9
          "sellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

":
"{String}",
10
          "sellersPaymentReference
SellersPaymentReference

Sellers reference to identify the object. In Norway this is typically a KID-number.

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

Customers reference. Typically a person.

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

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

":
"{String}",
13
          "exchangeRateFluctuationAgreement
ExchangeRateFluctuationAgreement

When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.

Possible domain values can be found here

":
"{String}",
14
          "grossMargin
GrossMargin

Gross margin of sale, calculated as an average of gross margin of all items at the time items are created and when the document is registered. Will not be recalculated if gross margin in items change afterwards

":
"{Decimal}",
15
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

":
"{String}",
16
          "creditReason
CreditReason

Field used to specify the reason for the credit

":
"{String}",
17
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

":
"{String}",
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.

":
"{String}",
22
          "includeInDunningJobs
IncludeInDunningJobs

Indicates if a sales invoice and / or credit note is included in dunning job.

":
"{Boolean}",
23
          "includeInInterestJobs
IncludeInInterestJobs

Indicates if a sales invoice and / or credit note is included in interest job.

":
"{Boolean}",
24
          "externalReference
ExternalReference

External sales credit note reference/identifier. Can be used in external systems.

":
{
25
               "isSubjectedToSplitPayment
IsSubjectedToSplitPayment

Indicates if an customer / supplier invoice and / or credit note is subjected to split payment

":
"{Boolean}",
26
               "isInternal
IsInternal

Indicates if an customer / supplier invoice and / or credit note is marked as internal

":
"{Boolean}",
27
               "eUSaleToNonCompany
EUSaleToNonCompany

Sales from Poland to EU country, to natural persons who do not conduct business activity (non company).

":
"{Boolean}",
28
               "thirdPartyTransactionCode
ThirdPartyTransactionCode

Transaction code used when purchasing goods in the EU by the third largest VAT payer in a triangular transaction.

Possible domain values can be found here

":
"{String}",
29
               "isCorrectionInvoice
IsCorrectionInvoice

Indicates if an credit note is marked as a correction invoice

":
"{Boolean}"
30
          },
31
          "location": {
32
               "shortName
ShortName

Unique abbreviation/short name of the location

":
"{String}"
33
          },
34
          "accountingPeriod": {
35
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

":
"{Integer}",
36
               "period
Period

Accounting period

":
"{Integer}",
37
               "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

":
"{String}"
38
          },
39
          "assignee
Assignee

The user who has been assigned to work with this object.

":
{
40
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

":
"{String}"
44
          },
45
          "customer": {
46
               "customerId
CustomerId

Customer identifier

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

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

":
"{String}",
48
               "firstname
Firstname

Secondary name of a company or firstname of a person

":
"{String}",
49
               "legalEntityIdentifier
LegalEntityIdentifier

The customers unique enterprise/organization number.

":
"{String}",
50
               "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

":
"{String}",
51
               "intercompany": {
52
                    "code
Code

Intercompany database the customer belongs to.

":
"{String}"
53
               },
54
               "sales": {
55
                    "salesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

":
"{String}",
56
                    "marketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

":
{
57
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
58
                         "lastName
LastName

Last name of employee

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

First name of employee

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

Employee reference

":
"{String}",
61
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
62
                         "lastName
LastName

Last name of employee

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

First name of employee

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

Employee reference

":
"{String}"
65
                    }
66
               },
67
               "customerLegalEntity": {
68
                    "customerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

":
"{Integer}",
69
                    "customerLegalEntityLink
CustomerLegalEntityLink

Reference to customer legal entity

":
"{String}"
70
               },
71
               "customerLink
CustomerLink

Customer reference

":
"{String}"
72
          },
73
          "shippingAddress": {
74
               "addressId
AddressId

Address identifier

":
"{Integer}",
75
               "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}",
76
               "firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

External address identifier. Normally defined by the customer.

":
"{String}"
85
          },
86
          "invoiceAddress": {
87
               "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}",
88
               "firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

":
"{String}"
96
          },
97
          "totals": {
98
               "currency
Currency

Three character code following the ISO 4217 standard

":
"{String}",
99
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

":
"{Decimal}",
100
               "feeAmount
FeeAmount

Fee amount in transaction document's currency

":
"{Decimal}",
101
               "roundOffAmount
RoundOffAmount

Round-off amount in transaction document's currency

":
"{Decimal}",
102
               "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

":
"{Decimal}",
103
               "vATAmount
VATAmount

Total value added tax in object currency.

":
"{Decimal}",
104
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

":
"{Decimal}",
105
               "vATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in transaction document's currency

":
"{Decimal}",
106
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

":
"{String}",
107
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

":
"{Decimal}",
108
               "freightAmount
FreightAmount

Freight amount in company currency.

":
"{Decimal}",
109
               "feeAmount
FeeAmount

Fee amount in company currency

":
"{Decimal}",
110
               "roundOffAmount
RoundOffAmount

Round-off amount in company currency

":
"{Decimal}",
111
               "subTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

":
"{Decimal}",
112
               "vATAmount
VATAmount

Value added tax amount in company currency.

":
"{Decimal}",
113
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

":
"{Decimal}",
114
               "vATRoundOffAmount
VATRoundOffAmount

VAT round-off amount in company currency

":
"{Decimal}"
115
          },
116
          "shipment": {
117
               "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}",
118
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

":
"{String}",
119
               "shippingService": {
120
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

":
"{String}",
122
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

":
"{String}"
123
               }
124
          },
125
          "payment": {
126
               "paymentTerms
PaymentTerms

Default payment terms to use in new documents.

Possible domain values can be found here

":
"{String}",
127
               "paymentMethod
PaymentMethod

Default payment method for the customer

Possible domain values can be found here

":
"{String}",
128
               "dueDate
DueDate

Date the object is due to be paid

":
"{Date}"
129
          },
130
          "vATDetails": {
131
               "postponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

":
"{Boolean}",
132
               "vATType
VATType

Type of value added tax

":
"{String}",
133
               "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}",
134
               "vATRate
VATRate

Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.

":
"{Decimal}",
135
               "vATDate
VATDate

Date of VAT posting. Currency rate calculation use this date.

":
"{Date}",
136
               "vATPeriod
VATPeriod

Accounting period this VAT posting belongs to

":
"{Integer}",
137
               "defaultVATPercent
DefaultVATPercent

Value added tax percent.

":
"{Decimal}",
138
               "defaultVATCodeDefinition": {
139
                    "vATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

":
"{Integer}",
140
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

":
"{String}",
142
                    "vATCodeDefinitionLink
VATCodeDefinitionLink

VAT code reference

":
"{String}"
143
               },
144
               "vATEntity": {
145
                    "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

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

Three character code following the ISO 4217 standard

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

Country name of VAT entity

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

Country code of VAT Entity

":
"{String}"
149
               },
150
               "notificationId
NotificationId

Notification identifier

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

Status of the notification

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

Date and time of creation

":
"{Datetime}",
153
               "message
Message

The message from the notification definition, expanded with parameters.

":
"{String}",
154
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

":
"{String}",
155
               "notificationType": {
156
                    "notificationTypeId
NotificationTypeId

Notification type identifier

":
"{String}",
157
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

":
"{String}",
158
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

":
"{String}"
159
               },
160
               "notificationLink
NotificationLink

Notification reference

":
"{String}"
161
          }
162
     }
163
}

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 101402 HTTP 404 Customer on purchase quote mismatch with this account
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 103838 HTTP 400 Recalculation failed. Missing location.
Error 101069 HTTP 404 Stock assignment link - document not found
Error 100345 HTTP 400 Location is required
Error 108514 HTTP 400 Invalid invoice frequency
Error 108635 HTTP 400 Effective date cannot be later then effective date of any contract item
Error 108421 HTTP 400 The effective date cannot be later than the expiration date
Error 108735 HTTP 400 Expiration date of a contract cannot be earlier then expiration date of any of its quotes
Error 108674 HTTP 400 Termination date cannot be earlier then the effective date
Error 108675 HTTP 400 Termination date cannot be later then the expiration date
Error 108672 HTTP 400 Closing date cannot be earlier then the effective date
Error 108673 HTTP 400 Closing date cannot be later then the expiration date
Error 104971 HTTP 400 The start date cannot be later than the end date
Error 103491 HTTP 400 Invalid expiration date
Error 108262 HTTP 404 Recurring rate not found
Error 108691 HTTP 400 Recurring rate is not active
Error 108018 HTTP 400 Currency mismatch
Error 108016 HTTP 400 Product id mismatch
Error 108824 HTTP 400 Cannot apply recurring rate as it is not valid for selected period
Error 108671 HTTP 400 The effective date cannot be changed because earlier days have already been invoiced
Error 108684 HTTP 400 The expiration date cannot be changed because later days have already been invoiced
Error 108677 HTTP 400 Expected delivery date cannot be earlier than the effective date
Error 108678 HTTP 400 Expected collection date cannot be earlier than the effective date
Error 108679 HTTP 400 Expected collection date cannot be earlier then expected delivery date
Error 108680 HTTP 400 Collection date cannot be earlier then the effective date
Error 108681 HTTP 400 Collection date cannot be earlier then the expected delivery date
Error 108683 HTTP 400 Termination date must be earlier then the expiration date
Error 107278 HTTP 400 No available rental unit found for specified product and date range