Update a Receipt

PUT /receipts/{id} — Use this method to update the receipt with the specified internal ID.

Parameters

Path parameters

Path parameter	Required / Optional	Description	Type
{id}	Required	The internal ID of the receipt.	integer

Query string parameter

Path parameter	Required / Optional	Description	Type
expand	Optional	A comma-separated list of attributes available for expansion. The comma-separated list may include spaces (or %20 in the URL encoded string). Note: The expand value must contain only attributes referencing a supported object type. If return_object is set to any value other than 0 (zero), and the comma-separated list includes at least one attribute that is not available for expansion, the request fails — an error is returned and the object is not added or updated. For more information about attributes available for expansion and supported object types, see Available Expansions and Supported Object Types.	string
fields	Optional	A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the receipt returned.	string
filterSetId	Optional	The internal ID of the filter set to be applied. When specified, the request is successful only if the action is available when the specified filter set is active in OpenAir. The filter set with the specified internal ID must exist and must be associated with the user who authorized the application as per the access token. Otherwise and by default, the primary filter set associated with the user who authorized the application is applied.	integer
return_object	Optional	If set to any value other than 0 (zero), the response will include the receipt updated. Otherwise, the response will include only the internal ID of the receipt updated.	Boolean

Request body

An object including valid key-value pairs for the fields to be updated. The object cannot include key-value pairs for read-only attributes. For information about the Receipt object model, see Receipt object properties.

Response definitions

A successful request returns a JSON object with the following properties:

Property	Description
data	An array containing one of the following: The Receipt object updated, if the return_object parameter was set to any value other than 0 (zero) in the request. The object includes all the attributes specified using the fields if included in the request. An object with only the ID of the receipt updated. See Returned Data.
included	An array of expanded objects, if the expand parameter was set in the request. See Referenced Objects and Expansion.
meta	An object containing information about objects referenced by internal ID in the data array (object type and internal ID). Only returned if the return_object parameter was set to any value other than 0 (zero) in the request. See Referenced Objects and Expansion.
message	A string containing a brief message about the status of your request — e.g. “Success”.

A failed request returns a JSON object with the following properties:

Property	Description
message	A string containing a brief message about the status of your request — e.g. “Receipt #2675 not found”.

Sample request

            PUT /rest/v1/receipts/2674 HTTP/1.1
Host: company-id.app.openair.com
Content-Type: application/json
Authorization: Bearer <OAuth2_access_token>

{
            "externalId": "4823",
            "accountingDate": "2019-10-30",
            "currency": "CAD",
} 

          

In the example, <OAuth2_access_token> is the OAuth 2.0 access token obtained for the client application connecting to OpenAir. See Authentication.

Sample response

            {
   "data": [
      {
         "id": 2674
      }
   ],
   "message": "success"
}