API

Sales APIs

GET sales/project-orders/expenses

List of expenses

HTTP method GET
URI https://api.rambase.net/sales/project-orders/expenses
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5745, version 12

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.

ApprovedByMe() Named filter Expenses approved by me
ExcludeDeleted() Named filter Exclude deleted expenses (Status D) from the list
MyExpenses() Named filter My expenses
PendingApproval() Named filter Pending approval expenses (Status 3)
PendingMyApproval() Named filter Expenses pending my approval (Status 3)
AddedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ApprovedAt Datetime The date and time the expense was approved. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ApprovedBy Integer Employee identifier.
ExpenseId Integer Expense identifier.
ExternalNote String Note to customer, may be added to reports or details attached to the invoice.
IncurredDate Date The date the expense incurred (e.g. the date the kilometers was driven). Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
InternalNote String Note for internal use.
Price Decimal Price of the expense in sales currency.
ProjectOrderId Integer Project order identifier.
ProjectOrderItemId Integer Project order item identifier.
Quantity Decimal Quantity of the expenses.
RegardingEmployeeId Integer Employee identifier. Available macros: currentUser()
Responsible Integer Employee identifier.
Status String Expense status.
Total Decimal Cost of the expense in sales currency (QTY * COSTPRICE).

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

AddedAt Datetime Date and time of creation
ApprovedAt Datetime The date and time the expense was approved
ApprovedBy Integer Employee identifier
ExpenseId Integer Expense identifier
ExternalNote String Note to customer, may be added to reports or details attached to the invoice
IncurredDate Date The date the expense incurred (e.g. the date the kilometers was driven)
InternalNote String Note for internal use
Price Decimal Price of the expense in sales currency
ProjectOrderId Integer Project order identifier
ProjectOrderItemId Integer Project order item identifier
Quantity Decimal Quantity of the expenses
RegardingEmployeeId Integer Employee identifier
Responsible Integer Employee identifier
Status String Expense status
Total Decimal Cost of the expense in sales currency (QTY * COSTPRICE)

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
<Expenses>
2
     <Expense>
3
          <ExpenseId
ExpenseId

Expense identifier

>{Integer}</ExpenseId>
4
          <AddedAt
AddedAt

Date and time of creation

>{Datetime}</AddedAt>
5
          <Status
Status

Expense status

Possible domain values can be found here

>{String}</Status>
6
          <InternalNote
InternalNote

Note for internal use

>{String}</InternalNote>
7
          <ExternalNote
ExternalNote

Note to customer, may be added to reports or details attached to the invoice

>{String}</ExternalNote>
8
          <Quantity
Quantity

Quantity of the expenses

>{Decimal}</Quantity>
9
          <Cost>
10
               <Price
Price

Price of the expense in sales currency

>{Decimal}</Price>
11
               <Total
Total

Cost of the expense in sales currency (QTY * COSTPRICE)

>{Decimal}</Total>
12
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
13
          </Cost>
14
          <IncurredDate
IncurredDate

The date the expense incurred (e.g. the date the kilometers was driven)

>{Date}</IncurredDate>
15
          <ApprovedAt
ApprovedAt

The date and time the expense was approved

>{Date}</ApprovedAt>
16
          <ApprovedBy
ApprovedBy

Personal identifier of the manager who approved this expense

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

>
17
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
21
          </ApprovedBy>
22
          <RegardingEmployee
RegardingEmployee

Personal identifier of the employee who logged the expense

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

>
23
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
27
          </RegardingEmployee>
28
          <ProjectOrderItem
ProjectOrderItem

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

>
29
               <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

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

>{Integer}</ProjectOrderItemId>
30
               <ProductDescription
ProductDescription

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

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

>{String}</ProductDescription>
31
               <Product
Product

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

>
32
                    <ProductId
ProductId

Product identifier

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

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

Name of the product

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

>{String}</Name>
34
                    <MeasurementUnit
MeasurementUnit

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

>
35
                         <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

>{Integer}</MeasurementUnitId>
36
                         <Precision
Precision

The precision/accuracy of the measurement (number of decimals)

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

>{Integer}</Precision>
37
                         <Unit
Unit

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

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

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

Material unit reference

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

>{String}</MeasurementUnitLink>
39
                    </MeasurementUnit>
40
                    <ProductLink
ProductLink

Product reference

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

>{String}</ProductLink>
41
               </Product>
42
               <ProjectOrder
ProjectOrder

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

>
43
                    <ProjectOrderId
ProjectOrderId

Project order identifier

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

>{Integer}</ProjectOrderId>
44
                    <Name
Name

Name of the project order

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

>{String}</Name>
45
                    <Responsible
Responsible

Reference to the user who is responsible project manger for this project order

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

>
46
                         <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
50
                    </Responsible>
51
                    <ProjectOrderLink
ProjectOrderLink

Project order reference

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

>{String}</ProjectOrderLink>
52
               </ProjectOrder>
53
               <ProjectOrderItemLink
ProjectOrderItemLink

Project order item reference

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

>{String}</ProjectOrderItemLink>
54
          </ProjectOrderItem>
55
     </Expense>
56
     <Paging
Paging

Detailed paging information for this list.

>
57
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
60
          <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>
61
          <FirstPage
FirstPage

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

>{String}</FirstPage>
62
          <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>
63
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
64
          <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>
65
          <NextPage
NextPage

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

>{String}</NextPage>
66
          <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>
67
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
69
     </Paging>
70
</Expenses>
1
{
2
     "expenses": [
3
          {
4
               "expenseId
ExpenseId

Expense identifier

": "{Integer}",
5
               "addedAt
AddedAt

Date and time of creation

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

Expense status

Possible domain values can be found here

": "{String}",
7
               "internalNote
InternalNote

Note for internal use

": "{String}",
8
               "externalNote
ExternalNote

Note to customer, may be added to reports or details attached to the invoice

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

Quantity of the expenses

": "{Decimal}",
10
               "cost": {
11
                    "price
Price

Price of the expense in sales currency

": "{Decimal}",
12
                    "total
Total

Cost of the expense in sales currency (QTY * COSTPRICE)

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}"
14
               },
15
               "incurredDate
IncurredDate

The date the expense incurred (e.g. the date the kilometers was driven)

": "{Date}",
16
               "approvedAt
ApprovedAt

The date and time the expense was approved

": "{Date}",
17
               "approvedBy
ApprovedBy

Personal identifier of the manager who approved this expense

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

": {
18
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
22
               },
23
               "regardingEmployee
RegardingEmployee

Personal identifier of the employee who logged the expense

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

": {
24
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
28
               },
29
               "projectOrderItem
ProjectOrderItem

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

": {
30
                    "projectOrderItemId
ProjectOrderItemId

Project order item identifier

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

": "{Integer}",
31
                    "productDescription
ProductDescription

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

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

": "{String}",
32
                    "product
Product

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

": {
33
                         "productId
ProductId

Product identifier

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

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

Name of the product

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

": "{String}",
35
                         "measurementUnit
MeasurementUnit

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

": {
36
                              "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

": "{Integer}",
37
                              "precision
Precision

The precision/accuracy of the measurement (number of decimals)

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

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

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

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

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

Material unit reference

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

": "{String}"
40
                         },
41
                         "productLink
ProductLink

Product reference

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

": "{String}"
42
                    },
43
                    "projectOrder
ProjectOrder

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

": {
44
                         "projectOrderId
ProjectOrderId

Project order identifier

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

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

Name of the project order

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

": "{String}",
46
                         "responsible
Responsible

Reference to the user who is responsible project manger for this project order

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

": {
47
                              "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
51
                         },
52
                         "projectOrderLink
ProjectOrderLink

Project order reference

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

": "{String}"
53
                    },
54
                    "projectOrderItemLink
ProjectOrderItemLink

Project order item reference

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

": "{String}"
55
               }
56
          }
57
     ],
58
     "paging
Paging

Detailed paging information for this list.

": {
59
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
62
          "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}",
63
          "firstPage
FirstPage

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

": "{String}",
64
          "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}",
65
          "previousPage
PreviousPage

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

": "{String}",
66
          "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}",
67
          "nextPage
NextPage

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

": "{String}",
68
          "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}",
69
          "lastPage
LastPage

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

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

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

": "{Integer}"
71
     }
72
}

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 102120 HTTP 404 Delivery project not found
Error 100001 HTTP 404 Address not found
Error 101420 HTTP 404 Setting definition not found