API

Sales APIs

GET sales/project-orders/{projectOrderId}/items/{itemId}/expenses/{expenseId}

Expense details for the provided identifier

HTTP method GET
URI https://api.rambase.net/sales/project-orders/{projectOrderId}/items/{itemId}/expenses/{expenseId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {projectOrderId} Project order identifier
Integer, minimum 100000
- URI parameter {itemId} Project order item identifier
Integer, minimum 1
- URI parameter {expenseId} Expense identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 5744, version 5

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.

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

Expense identifier

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

Date and time of creation

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

Expense status

Possible domain values can be found here

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

Note for internal use

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

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

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

Quantity of the expenses

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

Price of the expense in sales currency

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

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

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

The date and time the expense was approved

>{Date}</ApprovedAt>
15
     <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=ApprovedBy in your request URI to get this field

>
16
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
20
     </ApprovedBy>
21
     <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=RegardingEmployee in your request URI to get this field

>
22
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
26
     </RegardingEmployee>
27
</Expense>
1
{
2
     "expense": {
3
          "expenseId
ExpenseId

Expense identifier

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

Date and time of creation

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

Expense status

Possible domain values can be found here

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

Note for internal use

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

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

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

Quantity of the expenses

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

Price of the expense in sales currency

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

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

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

The date and time the expense was approved

": "{Date}",
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=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=ApprovedBy in your request URI to get this field

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
21
          },
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=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=RegardingEmployee in your request URI to get this field

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
27
          }
28
     }
29
}

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