API

Sales APIs

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

Updates an expense

HTTP method PUT
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 5746, version 1

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

This field is optional.

>
2
     <Quantity
Quantity

Quantity of the expenses

Minimum value: 0

This field is optional.

>
{Decimal}</Quantity>
3
     <Cost
Cost

This field is optional.

>
4
          <Price
Price

Price of the expense in sales currency

Minimum value: 0

This field is optional.

>
{Decimal}</Price>
5
     </Cost>
6
     <IncurredDate
IncurredDate

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

This field is optional.

>
{Date}</IncurredDate>
7
     <InternalNote
InternalNote

Note for internal use

This field is optional.

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

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

This field is optional.

>
{String}</ExternalNote>
9
     <RegardingEmployee
RegardingEmployee

Personal identifier of the employee who logged the expense

This field is optional.

>
10
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
11
     </RegardingEmployee>
12
</Expense>
1
{
2
     "expense
Expense

This field is optional.

":
{
3
          "quantity
Quantity

Quantity of the expenses

Minimum value: 0

This field is optional.

":
"{Decimal}",
4
          "cost
Cost

This field is optional.

":
{
5
               "price
Price

Price of the expense in sales currency

Minimum value: 0

This field is optional.

":
"{Decimal}"
6
          },
7
          "incurredDate
IncurredDate

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

This field is optional.

":
"{Date}",
8
          "internalNote
InternalNote

Note for internal use

This field is optional.

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

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

This field is optional.

":
"{String}",
10
          "regardingEmployee
RegardingEmployee

Personal identifier of the employee who logged the expense

This field is optional.

":
{
11
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
12
          }
13
     }
14
}

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

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

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
1

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 102696 HTTP 404 Formula definition not found
Error 102704 HTTP 404 Formula parameter was not found
Error 102746 HTTP 400 The parameter value can not be more than {0}
Error 102747 HTTP 400 Error in formula: {0}
Error 107148 HTTP 400 Category must be 'Expenses'
Error 107981 HTTP 400 Expense logs can only be created for registered (status 4) project order items
Error 105142 HTTP 404 Project order item was not found
Error 107982 HTTP 400 Manager not found