API

Sales APIs

GET sales/invoices/{salesInvoiceId}

Sales invoice details for the provided identifier

HTTP method GET
URI https://api.rambase.net/sales/invoices/{salesInvoiceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesInvoiceId} Sales invoice identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 262, version 95

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

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

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SalesInvoice>
2
     <SalesInvoiceId
SalesInvoiceId

Sales invoice identifier

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

Status of the sales invoice

Possible domain values can be found here

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

Type of sales invoice

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
     <Note
Note

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

>{String}</Note>
16
     <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>
17
     <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>
18
     <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>
19
     <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>
20
     <IncludeInDunningJobs
IncludeInDunningJobs

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

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

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

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

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

>{String}</ExternalReference>
23
     <PolishRequirements
PolishRequirements

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

>
24
          <IsSubjectedToSplitPayment
IsSubjectedToSplitPayment

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

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

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

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

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

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

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

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

>{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

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

>{String}</ThirdPartyTransactionCode>
28
     </PolishRequirements>
29
     <Location>
30
          <LocationId
LocationId

Location identifier

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

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

Unique abbreviation/short name of the location

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

Location reference

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

>{String}</LocationLink>
33
     </Location>
34
     <AccountingPeriod>
35
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

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

Accounting period

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

Accounting period reference

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

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

>
40
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</Firstname>
49
          <Phone
Phone

Customers main phone number

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

>{String}</Phone>
50
          <Email
Email

Customers main email

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

>{String}</Email>
51
          <LegalEntityIdentifier
LegalEntityIdentifier

The customers unique enterprise/organization number.

>{String}</LegalEntityIdentifier>
52
          <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>
53
          <Intercompany>
54
               <Code
Code

Intercompany database the customer belongs to.

>{String}</Code>
55
          </Intercompany>
56
          <Sales>
57
               <SalesDistrict
SalesDistrict

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

Possible domain values can be found here

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

Market segment of the customer

Possible domain values can be found here

>{String}</MarketSegment>
59
               <SalesAssistant
SalesAssistant

Reference to the employee who is sales assistant for the customer.

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

>
60
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
64
               </SalesAssistant>
65
               <AccountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

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

>
66
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
70
               </AccountManager>
71
          </Sales>
72
          <CustomerLegalEntity>
73
               <CustomerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

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

Reference to customer legal entity

>{String}</CustomerLegalEntityLink>
75
          </CustomerLegalEntity>
76
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
77
     </Customer>
78
     <ShippingAddress>
79
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
80
          <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>
81
          <Firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

External address identifier. Normally defined by the customer.

>{String}</ExternalReference>
90
          <GlobalLocationNumber
GlobalLocationNumber

Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.

>{String}</GlobalLocationNumber>
91
     </ShippingAddress>
92
     <InvoiceAddress>
93
          <AddressId
AddressId

Address identifier

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

>{Integer}</AddressId>
94
          <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>
95
          <Firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>{String}</Country>
103
          <GlobalLocationNumber
GlobalLocationNumber

Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.

>{String}</GlobalLocationNumber>
104
     </InvoiceAddress>
105
     <Totals>
106
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Freight amount in transaction document's currency

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

Fee amount in transaction document's currency

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

Round-off amount in transaction document's currency

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

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

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

Total value added tax in object currency.

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

The total amount in object currency, including VAT

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

VAT round-off amount in transaction document's currency

>{Decimal}</VATRoundOffAmount>
114
     </Totals>
115
     <TotalsConverted
TotalsConverted

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

>
116
          <Currency
Currency

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

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

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

The exchange rate used in convertion

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

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

Freight amount in company currency.

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

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

Fee amount in company currency

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

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

Round-off amount in company currency

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

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

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

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

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

Value added tax amount in company currency.

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

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

The total amount in company currency, including VAT.

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

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

VAT round-off amount in company currency

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

>{Decimal}</VATRoundOffAmount>
125
     </TotalsConverted>
126
     <Shipment>
127
          <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>
128
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
129
          <ShippingService>
130
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

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

Shipping service reference

>{String}</ShippingServiceLink>
133
          </ShippingService>
134
     </Shipment>
135
     <Payment>
136
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

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

Method of payment. Default value is retrieved from the customer.

Possible domain values can be found here

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

Date the object is due to be paid

>{Date}</DueDate>
139
          <CreditCardTransaction>
140
               <CreditCardTransactionId
CreditCardTransactionId

Credit card transaction identifier

>{Integer}</CreditCardTransactionId>
141
               <CreditCardTransactionLink
CreditCardTransactionLink

Credit card transaction reference

>{String}</CreditCardTransactionLink>
142
          </CreditCardTransaction>
143
     </Payment>
144
     <VATDetails>
145
          <PostponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

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

Type of value added tax

>{String}</VATType>
147
          <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>
148
          <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>
149
          <VATDate
VATDate

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

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

Accounting period this VAT posting belongs to

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

Value added tax percent.

>{Decimal}</DefaultVATPercent>
152
          <DefaultVATCodeDefinition>
153
               <VATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

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

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

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

VAT code reference

>{String}</VATCodeDefinitionLink>
157
          </DefaultVATCodeDefinition>
158
          <VATEntity>
159
               <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>
160
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Country name of VAT entity

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

Country code of VAT Entity

>{String}</CountryCode>
163
          </VATEntity>
164
     </VATDetails>
165
     <HighlightedNotification
HighlightedNotification

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

>
166
          <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

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

The message from the notification definition, expanded with parameters.

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

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

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

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

>{String}</TranslatedMessage>
171
          <NotificationType
NotificationType

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

>
172
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

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

Notification type reference

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

>{String}</NotificationTypeLink>
175
          </NotificationType>
176
          <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
177
     </HighlightedNotification>
178
</SalesInvoice>
1
{
2
     "salesInvoice": {
3
          "salesInvoiceId
SalesInvoiceId

Sales invoice identifier

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

Status of the sales invoice

Possible domain values can be found here

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

Type of sales invoice

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
          "note
Note

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

": "{String}",
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}",
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}",
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}",
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}",
21
          "includeInDunningJobs
IncludeInDunningJobs

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

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

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

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

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

": "{String}",
24
          "polishRequirements
PolishRequirements

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

": {
25
               "isSubjectedToSplitPayment
IsSubjectedToSplitPayment

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

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

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

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

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

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

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

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

": "{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

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

": "{String}"
29
          },
30
          "location": {
31
               "locationId
LocationId

Location identifier

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

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

Unique abbreviation/short name of the location

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

Location reference

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

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

Accounting period identifier

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

Accounting period

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

Accounting period reference

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

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

": {
41
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

": "{String}",
50
               "phone
Phone

Customers main phone number

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

": "{String}",
51
               "email
Email

Customers main email

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

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

The customers unique enterprise/organization number.

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

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

": "{String}",
54
               "intercompany": {
55
                    "code
Code

Intercompany database the customer belongs to.

": "{String}"
56
               },
57
               "sales": {
58
                    "salesDistrict
SalesDistrict

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

Possible domain values can be found here

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

Market segment of the customer

Possible domain values can be found here

": "{String}",
60
                    "salesAssistant
SalesAssistant

Reference to the employee who is sales assistant for the customer.

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

": {
61
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
65
                    },
66
                    "accountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

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

": {
67
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
71
                    }
72
               },
73
               "customerLegalEntity": {
74
                    "customerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

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

Reference to customer legal entity

": "{String}"
76
               },
77
               "customerLink
CustomerLink

Customer reference

": "{String}"
78
          },
79
          "shippingAddress": {
80
               "addressId
AddressId

Address identifier

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

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

External address identifier. Normally defined by the customer.

": "{String}",
91
               "globalLocationNumber
GlobalLocationNumber

Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.

": "{String}"
92
          },
93
          "invoiceAddress": {
94
               "addressId
AddressId

Address identifier

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

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

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

": "{String}",
104
               "globalLocationNumber
GlobalLocationNumber

Global location number (GLN) for the address. GLN is part of the GS1 systems of standards and is a 13-digit number used to uniquely identify any legal entity, functional entity, or physical location.

": "{String}"
105
          },
106
          "totals": {
107
               "currency
Currency

Three character code following the ISO 4217 standard

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

Freight amount in transaction document's currency

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

Fee amount in transaction document's currency

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

Round-off amount in transaction document's currency

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

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

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

Total value added tax in object currency.

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

The total amount in object currency, including VAT

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

VAT round-off amount in transaction document's currency

": "{Decimal}"
115
          },
116
          "totalsConverted
TotalsConverted

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

": {
117
               "currency
Currency

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

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

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

The exchange rate used in convertion

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

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

Freight amount in company currency.

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

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

Fee amount in company currency

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

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

Round-off amount in company currency

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

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

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

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

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

Value added tax amount in company currency.

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

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

The total amount in company currency, including VAT.

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

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

VAT round-off amount in company currency

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

": "{Decimal}"
126
          },
127
          "shipment": {
128
               "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}",
129
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

": "{String}",
130
               "shippingService": {
131
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

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

Shipping service reference

": "{String}"
134
               }
135
          },
136
          "payment": {
137
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

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

Method of payment. Default value is retrieved from the customer.

Possible domain values can be found here

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

Date the object is due to be paid

": "{Date}",
140
               "creditCardTransaction": {
141
                    "creditCardTransactionId
CreditCardTransactionId

Credit card transaction identifier

": "{Integer}",
142
                    "creditCardTransactionLink
CreditCardTransactionLink

Credit card transaction reference

": "{String}"
143
               }
144
          },
145
          "vATDetails": {
146
               "postponeVAT
PostponeVAT

Indicates that the VAT posting should be postponed

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

Type of value added tax

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

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

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

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

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

Accounting period this VAT posting belongs to

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

Value added tax percent.

": "{Decimal}",
153
               "defaultVATCodeDefinition": {
154
                    "vATCodeDefinitionId
VATCodeDefinitionId

VAT code identifier

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

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

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

VAT code reference

": "{String}"
158
               },
159
               "vATEntity": {
160
                    "vATRegistrationNumber
VATRegistrationNumber

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

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

Three character code following the ISO 4217 standard

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

Country name of VAT entity

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

Country code of VAT Entity

": "{String}"
164
               }
165
          },
166
          "highlightedNotification
HighlightedNotification

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

": {
167
               "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

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

The message from the notification definition, expanded with parameters.

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

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

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

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

": "{String}",
172
               "notificationType
NotificationType

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

": {
173
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

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

Notification type reference

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

": "{String}"
176
               },
177
               "notificationLink
NotificationLink

Notification reference

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

": "{String}"
178
          }
179
     }
180
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST
Confirm capture payment
Capture is confirmed by an external system for a specific sales invoice
AOP/100547
POST
Copy sales invoice to new invoice
AOP/101178
POST
Register sales invoice
AOP/101180
POST
Open sales invoice
AOP/101195
POST
Load sales invoice to general ledger
AOP/101198
POST
Forward all items to a new sales credit note
AOP/101199
POST
Delete all items for sales invoice
Delete all items for sales invoice
AOP/101202
POST
Deactivate dunning
AOP/101205
POST
Activate dunning
AOP/101206
POST
Deactivate interest
AOP/101208
POST
Activate interest
AOP/101209
POST
Forward all items to an existing sales credit note
AOP/101210
POST
Subjected to split payment
AOP/101212
POST
Not subjected to split payment
AOP/101213
POST
Is sent for debt collection
AOP/101216
POST
Undo is sent for debt collection
AOP/101217
POST
Change period including closed on sales invoice
AOP/101219
POST
Recalculate sales invoice
AOP/101220
POST
Change period on sales invoice
AOP/101221
POST
Forward all items to a new sales invoice
AOP/101222
POST
Forward all items to an existing sales invoice
AOP/101223
POST
Mark as internal sales invoice
AOP/101225
POST
Unmark as internal sales invoice
AOP/101226
POST
Delete all items and discard sales invoice
AOP/101229
POST
Update finance project on all items
AOP/101241
POST
Forward selected sales invoice items to a new sales credit note
AOP/101242
POST
Forward selected sales invoice items to an existing sales credit note
AOP/101243
POST
Forward selected sales invoice items to a new sales invoice
AOP/101244
POST
Forward selected sales invoice items to an existing sales invoice
AOP/101245
POST
Delete selected items for a sales invoice
AOP/101246
POST
Change country for direct shipment
AOP/101255
POST
Discard sales invoice
AOP/101282
POST
Open sales invoice
AOP/101310
POST
Copy customers reference number to all items
Update CustomersReferenceNumber in all items
AOP/101346
POST
Print timesheet
AOP/101403
POST
Set end customer on all sales invoice items
Copies the specified customer data to end customer fields for all sales invoice items
AOP/101584
POST
Update gross margin on all sales invoice items
AOP/101592
POST
Forward all items to a new correction invoice
AOP/101648
POST
Forward selected sales invoice items to a new correction invoice
AOP/101654
POST
Forward selected sales invoice items to an existing correction invoice
AOP/101655
POST
Split sales invoice
AOP/101766
POST
Change country code for expenses
AOP/101845

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found