API

Sales APIs

GET sales/delivery-projects/{salesDeliveryProjectId}/billing-items

List of billing items for a sales delivery project. The billing items are derived from sales orders of the delivery project

HTTP method GET
URI https://api.rambase.net/sales/delivery-projects/{salesDeliveryProjectId}/billing-items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesDeliveryProjectId} Sales delivery project identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2365, 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
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

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

CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerFirstname String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
ItemId Integer Item-number of the object.
ManufacturerShortName String Shortname/code of the manufacturer.
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ObjectId Integer Identifier of the object.
ObjectType String Type of object.
PaymentDueDate Date Date the object is due to be paid. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of billing item.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Seller Integer Employee identifier. Available macros: currentUser()
Status Integer Status of billing item.

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

CreatedAt Datetime Date and time of creation
CustomerFirstname String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
ItemId Integer Item-number of the object
ManufacturerShortName String Shortname/code of the manufacturer
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ObjectId Integer Identifier of the object
ObjectType String Type of object
PaymentDueDate Date Date the object is due to be paid
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity of billing item
RegistrationDate Date Date of registration
Seller Integer Employee identifier
Status Integer Status of billing item

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
<BillingItems>
2
     <BillingItem>
3
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
4
          <ItemType
ItemType

Type of item

>{String}</ItemType>
5
          <Status
Status

Status of billing item

>{Integer}</Status>
6
          <Type
Type

Type of sales invoice or type of sales credit note

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

Date and time of creation

>{Datetime}</CreatedAt>
8
          <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>{String}</ProductDescription>
9
          <Quantity
Quantity

Quantity of billing item

>{Decimal}</Quantity>
10
          <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
11
          <MeasurementUnit>
12
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
13
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
14
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
15
          </MeasurementUnit>
16
          <Product>
17
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
18
               <Name
Name

Name of the product

>{String}</Name>
19
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
20
               <Manufacturer>
21
                    <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
22
               </Manufacturer>
23
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
24
          </Product>
25
          <Seller
Seller

Reference to the seller of the item

>
26
               <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

>{String}</EmployeeLink>
30
          </Seller>
31
          <Price>
32
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
33
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
34
               <Discount
Discount

The discount for the item.

>{Decimal}</Discount>
35
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
36
          </Price>
37
          <PriceConverted
PriceConverted

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

>
38
               <Currency
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=BillingItem.PriceConverted in your request URI to get this field

>{String}</Currency>
39
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
40
               <NetPrice
NetPrice

Final price per unit after deducting all discounts.

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

>{Decimal}</NetPrice>
41
          </PriceConverted>
42
          <Totals>
43
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
44
               <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
45
               <DiscountAmount
DiscountAmount

The items discount amount.

>{Decimal}</DiscountAmount>
46
               <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
47
          </Totals>
48
          <TotalsConverted
TotalsConverted

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

>
49
               <Currency
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=BillingItem.TotalsConverted in your request URI to get this field

>{String}</Currency>
50
               <GrossAmount
GrossAmount

Total gross amount in company currency.

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

>{Decimal}</GrossAmount>
51
               <NetAmount
NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>
52
          </TotalsConverted>
53
          <Object>
54
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
55
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
56
               <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
57
               <CustomersReferenceNumber
CustomersReferenceNumber

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

>{String}</CustomersReferenceNumber>
58
               <Location>
59
                    <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
60
               </Location>
61
               <Customer>
62
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</Firstname>
65
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
66
               </Customer>
67
               <Payment>
68
                    <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
69
               </Payment>
70
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
71
          </Object>
72
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
73
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
74
     </BillingItem>
75
     <Paging
Paging

Detailed paging information for this list.

>
76
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

>{Integer}</Size>
88
     </Paging>
89
</BillingItems>
1
{
2
     "billingItems": [
3
          {
4
               "itemId
ItemId

Item-number of the object

": "{Integer}",
5
               "itemType
ItemType

Type of item

": "{String}",
6
               "status
Status

Status of billing item

": "{Integer}",
7
               "type
Type

Type of sales invoice or type of sales credit note

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

Date and time of creation

": "{Datetime}",
9
               "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
10
               "quantity
Quantity

Quantity of billing item

": "{Decimal}",
11
               "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
12
               "measurementUnit": {
13
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
14
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
15
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
16
               },
17
               "product": {
18
                    "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
21
                    "manufacturer": {
22
                         "shortName
ShortName

Shortname/code of the manufacturer

": "{String}"
23
                    },
24
                    "productLink
ProductLink

Product reference

": "{String}"
25
               },
26
               "seller
Seller

Reference to the seller of the item

": {
27
                    "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

": "{String}"
31
               },
32
               "price": {
33
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
34
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",
35
                    "discount
Discount

The discount for the item.

": "{Decimal}",
36
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
37
               },
38
               "priceConverted
PriceConverted

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

": {
39
                    "currency
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=BillingItem.PriceConverted in your request URI to get this field

": "{String}",
40
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
41
                    "netPrice
NetPrice

Final price per unit after deducting all discounts.

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

": "{Decimal}"
42
               },
43
               "totals": {
44
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
45
                    "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

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

The items discount amount.

": "{Decimal}",
47
                    "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
48
               },
49
               "totalsConverted
TotalsConverted

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

": {
50
                    "currency
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=BillingItem.TotalsConverted in your request URI to get this field

": "{String}",
51
                    "grossAmount
GrossAmount

Total gross amount in company currency.

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

": "{Decimal}",
52
                    "netAmount
NetAmount

Total net amount in company currency.

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

": "{Decimal}"
53
               },
54
               "object": {
55
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
56
                    "objectType
ObjectType

Type of object

": "{String}",
57
                    "registrationDate
RegistrationDate

Date of registration

": "{Date}",
58
                    "customersReferenceNumber
CustomersReferenceNumber

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

": "{String}",
59
                    "location": {
60
                         "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
61
                    },
62
                    "customer": {
63
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
67
                    },
68
                    "payment": {
69
                         "dueDate
DueDate

Date the object is due to be paid

": "{Date}"
70
                    },
71
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
72
               },
73
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
74
               "itemLink
ItemLink

API reference to the item

": "{String}"
75
          }
76
     ],
77
     "paging
Paging

Detailed paging information for this list.

": {
78
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
90
     }
91
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects