/expense-reports/{id}

import requests
url = "https://api.merge.dev/api/accounting/v1/expense-reports/id"
querystring = {"expand":"lines,employee,accounting_period,company"}
headers = {
    "X-Account-Token": "X-Account-Token",
    "Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "tracking_categories": [
    "a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d",
    "d4c3b2a1-9e8f-7g6h-5i4j-3k2l1m0n9o8p"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "remote_id": "exp_123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-01-31T12:00:00Z",
  "modified_at": "2024-01-31T14:30:00Z",
  "report_date": "2024-01-31T00:00:00Z",
  "report_identifier": "EXP-2024-001",
  "employee": "b9a9b824-6172-4d63-9d90-1c8a86c4f3b1",
  "status": "SUBMITTED",
  "total_amount": 150,
  "lines": [
    {
      "tracking_categories": [
        "cat-1",
        "cat-2"
      ],
      "id": "1234",
      "remote_id": "abcd-1234",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "account": "acc-1234",
      "description": "Client lunch meeting",
      "expense_date": "2024-01-15T00:00:00Z",
      "amount": 50,
      "currency": "USD",
      "exchange_rate": "1",
      "is_billable": true,
      "employee": "emp-1234",
      "project": "proj-5678",
      "company": "comp-1234",
      "contact": "cont-5678",
      "quantity": 1,
      "unit_price": 50,
      "non_reimbursable": false,
      "tax_amount": 5,
      "inclusive_of_tax": false,
      "tax_rate": "tax-1234",
      "remote_was_deleted": false,
      "integration_params": {
        "unique_integration_field": "unique_integration_field_value"
      },
      "linked_account_params": {
        "unique_linked_account_field": "unique_linked_account_field_value"
      },
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      }
    }
  ],
  "currency": "USD",
  "description": "January 2024 Travel Expenses",
  "accounting_period": "7d793c67-9f72-4a6b-9256-3936f237b0d9",
  "company": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/actions"
    }
  ],
  "remote_fields": [
    {
      "remote_field_class": {
        "id": "string",
        "display_name": "string",
        "remote_key_name": "string",
        "description": "string",
        "is_custom": true,
        "is_common_model_field": true,
        "is_required": true,
        "field_type": "string",
        "field_format": "string",
        "field_choices": [
          "string"
        ],
        "item_schema": {
          "item_type": "string",
          "item_format": "string",
          "item_choices": [
            "string"
          ]
        }
      },
      "value": "string"
    }
  ]
}

Returns an ExpenseReport object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

tracking_categorieslist of strings

The related tracking categories associated with the expense report

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

report_datedatetime or null

The date of the expense report.

report_identifierstring or null<=1024 characters

Human-readable expense report identifier.

employeestring or nullformat: "uuid"

Identifier for the employee who submitted or is associated with the expense report

statusenum or null

Overall status of the expense report. One of DRAFT, SUBMITTED, APPROVED, REJECTED

DRAFT - DRAFT
SUBMITTED - SUBMITTED
APPROVED - APPROVED
REJECTED - REJECTED

Overall status of the expense report. One of DRAFT, SUBMITTED, APPROVED, REJECTED * `DRAFT` - DRAFT * `SUBMITTED` - SUBMITTED * `APPROVED` - APPROVED * `REJECTED` - REJECTED

Allowed values:

total_amountdouble or null

Total amount of the expense report

lineslist of objectsRead-only

currencyenum or null

Currency code for the expense report. The currency code in ISO 4217 format.

descriptionstring or null<=1024 characters

A brief description or purpose for the expense report

accounting_periodstring or nullformat: "uuid"

The accounting period the report was posted in

companystring or nullformat: "uuid"

The subsidiary that the expense report is created in

remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

remote_fieldslist of objectsRead-only

/expense-reports/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration