Skip to main content
GET
/
expense-report
cURL
curl --request GET \
  --url https://api.joinslash.com/expense-report \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "legalEntityId": "<string>",
      "submittedByUserId": "<string>",
      "amountCents": 123,
      "currency": "<string>",
      "transactionDate": "2023-11-07T05:31:56Z",
      "destinationId": "<string>",
      "submittedAt": "2023-11-07T05:31:56Z",
      "status": "pending_review",
      "timestamp": "2023-11-07T05:31:56Z",
      "merchant": {
        "type": "merchantV2",
        "merchantV2": {
          "$entity": "merchant_v2",
          "id": "<string>",
          "name": "<string>",
          "isLive": true,
          "isInstantCashback": true,
          "metadata": {
            "timestamp": "2023-11-07T05:31:56Z"
          },
          "heronId": "<string>",
          "iconUrl": "<string>",
          "logoUrl": "<string>",
          "url": "<string>",
          "merchantCategoryId": "<string>"
        }
      },
      "merchantV2Id": "<string>",
      "customMerchantId": "<string>",
      "memo": "<string>",
      "fxRateToUsd": "<string>",
      "fxRateUpdatedAt": "2023-11-07T05:31:56Z",
      "noReceiptReason": "<string>",
      "documents": [
        {
          "document": {
            "$entity": "document",
            "id": "<string>",
            "accountType": "legalEntity",
            "accountId": "<string>",
            "startDate": "<string>",
            "endDate": "<string>",
            "status": "uploaded",
            "accessLevel": "<string>",
            "documentType": "business_entity",
            "category": "document",
            "timestamp": "<string>",
            "filename": "<string>",
            "error": "<string>",
            "checksum": "<string>",
            "tags": [
              "<string>"
            ],
            "documentSource": "uploaded",
            "fileMetadata": {
              "size": 123,
              "type": "<string>"
            }
          },
          "url": "<string>"
        }
      ],
      "aggregatedTransaction": {
        "id": "<string>",
        "date": "<string>",
        "toFrom": "<string>",
        "amount": {
          "amount_cents": 123,
          "currency": "USD"
        },
        "status": "pending",
        "account": "<string>",
        "method": "<string>",
        "category": "subscription",
        "additionalData": {
          "id": "<string>",
          "account": "cash",
          "panel": {
            "header": {
              "variant": "1-column",
              "title": "<string>",
              "subtitle": "<string>",
              "description": "<string>",
              "icon": {
                "imageUrl": "<string>"
              },
              "tags": [
                {
                  "text": "<string>",
                  "properties": {
                    "variant": "status",
                    "size": "small",
                    "status": "simple",
                    "includeMark": true
                  },
                  "key": "<string>"
                }
              ],
              "backgroundOverlayImage": {
                "src": "<string>",
                "position": "bottom-right"
              },
              "steps": [
                {
                  "key": "<string>",
                  "text": "<string>",
                  "isComplete": true,
                  "isActive": true,
                  "isLoading": true
                }
              ]
            },
            "body": {
              "sections": [
                "<unknown>"
              ],
              "listItems": [
                {
                  "text": "<string>",
                  "leftIcon": "<string>",
                  "linkReference": {
                    "type": "href",
                    "href": "<string>"
                  },
                  "selectionIndicator": {
                    "isSelected": true,
                    "indicatorIcon": "<string>"
                  },
                  "key": "<string>",
                  "size": "small"
                }
              ]
            }
          },
          "row": {
            "timestamp": "<string>",
            "status": "<string>",
            "transactionAvatar": {
              "size": "small",
              "contents": {
                "imageUrl": "<string>"
              },
              "badge": {
                "type": "indicator",
                "variant": "financial-badge-indicator",
                "size": "big",
                "subvariant": "refund"
              }
            },
            "titleIcon": "<string>",
            "titleText": "<string>",
            "titleTagObject": {
              "text": "<string>",
              "properties": {
                "variant": "status",
                "size": "small",
                "status": "simple",
                "includeMark": true
              },
              "key": "<string>"
            },
            "subtitleIcon": "<string>",
            "subtitleText": "<string>",
            "methodIcon": "<string>",
            "methodText": "<string>",
            "methodTagObject": {
              "text": "<string>",
              "properties": {
                "variant": "status",
                "size": "small",
                "status": "simple",
                "includeMark": true
              },
              "key": "<string>"
            },
            "accountIcon": "<string>",
            "accountText": "<string>",
            "accountTagObject": {
              "text": "<string>",
              "properties": {
                "variant": "status",
                "size": "small",
                "status": "simple",
                "includeMark": true
              },
              "key": "<string>"
            },
            "amount": {
              "amount_cents": 123,
              "currency": "USD"
            },
            "balance": {
              "amount_cents": 123,
              "currency": "USD"
            },
            "amountSubtext": "<string>",
            "amountSubicon": "<string>"
          },
          "listItems": [
            {
              "text": "<string>",
              "leftIcon": "<string>",
              "linkReference": {
                "type": "href",
                "href": "<string>"
              },
              "selectionIndicator": {
                "isSelected": true,
                "indicatorIcon": "<string>"
              },
              "key": "<string>",
              "size": "small"
            }
          ],
          "variant": "internal_authorization_clearing_adjustment",
          "transactionAvatar": {
            "imageUrl": "<string>"
          },
          "merchant": {
            "name": "<string>",
            "description": "<string>",
            "categoryCode": "<string>",
            "location": {
              "city": "<string>",
              "country": "<string>",
              "state": "<string>",
              "zip": "<string>"
            }
          },
          "approvalCode": "<string>",
          "orderId": "<string>",
          "note": "<string>",
          "uploads": [
            {
              "documentId": "<string>",
              "url": "<string>",
              "expiresAt": "<string>",
              "name": "<string>",
              "uploadType": "image/png"
            }
          ],
          "method": {
            "type": "card",
            "card": {
              "id": "<string>",
              "network": "<string>",
              "name": "<string>",
              "last4": "<string>"
            }
          },
          "currencyConversion": {
            "conversion_rate": 123,
            "original_amount": 123,
            "original_currency_code": "<string>"
          },
          "earnedCashback": {
            "amount_cents": 123,
            "currency": "USD",
            "rate": 123
          },
          "cashbackRedemptionDetails": {
            "toAccount": "<string>",
            "status": "<string>",
            "amount": {
              "amount_cents": 123,
              "currency": "USD"
            }
          },
          "advancedCardTransactionDetails": {
            "declineReason": "<string>",
            "approvalReason": "<string>",
            "formattedDeclineReason": {
              "reason": "<string>",
              "details": "<string>",
              "declineType": "<string>",
              "editAction": {
                "type": "card_group",
                "entityId": "<string>",
                "entityName": "<string>"
              }
            },
            "formattedDeclineReasonV2": {
              "declineType": "<string>",
              "declineSummary": "<string>",
              "declineDetails": "<string>",
              "cta": [
                {
                  "type": "go-to-card",
                  "props": {
                    "id": "<string>"
                  }
                }
              ],
              "metadata": {}
            }
          },
          "advancedAchDetails": {
            "counterpartyBank": "<string>",
            "receiverId": "<string>",
            "companyId": "<string>",
            "companyDiscretionaryData": "<string>",
            "companyEntryDescription": "<string>",
            "traceNumber": "<string>",
            "entryClassCode": "<string>",
            "paymentRelatedInfo": "<string>",
            "returnCode": "<string>",
            "returnReason": "<string>"
          },
          "advancedWireDetails": {
            "counterpartyBank": "<string>",
            "typeCode": "<string>",
            "subtypeCode": "<string>",
            "omad": "<string>",
            "imad": "<string>",
            "senderReference": "<string>",
            "businessFunctionCode": "<string>",
            "returnReason": "<string>"
          },
          "advancedInternationalWireDetails": {
            "uniqueId": "<string>",
            "instructionId": "<string>",
            "uetr": "<string>",
            "intermediaryBanks": [
              "<string>"
            ],
            "returnReason": "<string>"
          },
          "advancedCryptoDetails": {
            "txHash": "<string>",
            "senderAddress": "<string>",
            "isInstant": true,
            "isEligibleForInstant": true,
            "isStuck": true,
            "fiatRail": "ach"
          },
          "advancedRealtimeDetails": {
            "counterpartyBank": "<string>",
            "endToEndId": "<string>",
            "routingNumber": "<string>",
            "originatorName": "<string>",
            "description": "<string>"
          },
          "achDepositDetails": {
            "institutionName": "<string>",
            "accountName": "<string>",
            "accountOwner": "<string>",
            "accountType": "<string>",
            "accountNumber": "<string>",
            "estimatedTimeOfArrival": "2023-11-07T05:31:56Z"
          },
          "achOrWireSenderDetails": {
            "name": "<string>",
            "accountNumber": "<string>",
            "routingNumber": "<string>"
          },
          "transferRecipientDetails": {
            "name": "<string>",
            "accountNumber": "<string>",
            "routingNumber": "<string>",
            "accountType": "<string>",
            "address": "<string>"
          },
          "subaccountDetails": {
            "name": "<string>"
          },
          "transferApprovalDetails": {
            "automationRuleLifecycleApprovals": [
              {
                "approvedAt": "<string>",
                "approvedBy": "<string>"
              }
            ],
            "requestedAt": "<string>",
            "requestedBy": "<string>"
          },
          "accountDetails": {
            "balance": {
              "amount_cents": 123,
              "currency": "USD"
            }
          },
          "feeBreakdownDetails": {
            "relatedTransaction": {
              "id": "<string>",
              "amount": 123
            },
            "baseFee": {
              "amount_cents": 123,
              "currency": "USD",
              "rate": 123
            },
            "instantDepositFee": {
              "amount_cents": 123,
              "currency": "USD",
              "rate": 123
            },
            "marketOrderFee": {
              "amount_cents": 123,
              "currency": "USD",
              "rate": 123
            },
            "methodFee": {
              "amount_cents": 123,
              "currency": "USD",
              "method": "ach"
            }
          },
          "feeDetails": {
            "transferId": "<string>",
            "category": "foreign_transaction_fees"
          },
          "futureTransferDetails": {
            "futureActionRuleId": "<string>",
            "isRulePaused": true,
            "isActionSkipped": true,
            "transferType": "scheduled",
            "recurrencePattern": {
              "frequency": "none"
            },
            "endConfig": {
              "type": "never"
            },
            "requestedAt": "<string>",
            "recipient": {
              "name": "<string>",
              "type": "contact"
            },
            "requestedBy": "<string>",
            "startOn": "<string>"
          },
          "disputeDetails": {
            "disputeId": "<string>",
            "status": "filed",
            "amountCents": 123,
            "timestamp": "<string>",
            "updatedAt": "<string>",
            "linkedTransaction": {
              "type": "refund",
              "transferIntentId": "<string>",
              "transactionId": "<string>"
            }
          },
          "checkDepositDetails": {
            "frontDocumentId": "<string>",
            "backDocumentId": "<string>"
          },
          "transferTimingDetails": {
            "targetExecutionAt": "2023-11-07T05:31:56Z"
          },
          "instantDepositDetails": {
            "originalTransactionId": "<string>",
            "originalTransactionDate": "2023-11-07T05:31:56Z",
            "instantDepositTransactionId": "<string>",
            "instantDepositTransactionDate": "2023-11-07T05:31:56Z",
            "repaymentTransactionId": "<string>",
            "repaymentTransactionDate": "2023-11-07T05:31:56Z"
          }
        },
        "authorizedAt": "<string>",
        "variant": "internal_authorization_clearing_adjustment",
        "title": "<string>",
        "subtitle": "<string>",
        "methodEntityId": "<string>",
        "methodEntityTable": "<string>",
        "transferId": "<string>",
        "transferTable": "<string>",
        "transferEntityId": "<string>",
        "transferEntityTable": "<string>",
        "memo": "<string>",
        "userMemo": "<string>",
        "userReceipts": [
          {
            "documentId": "<string>",
            "url": "<string>",
            "expiresAt": "<string>",
            "name": "<string>",
            "uploadType": "image/png"
          }
        ],
        "memoRequired": true,
        "receiptRequired": true,
        "externalDescription": "<string>",
        "subaccountId": "<string>",
        "relatedAggregatedTransactionId": "<string>"
      },
      "destination": {
        "id": "<string>",
        "userId": "<string>",
        "latestStatus": "active",
        "accountName": "<string>",
        "type": "<string>",
        "subtype": "<string>",
        "institution": {
          "id": "<string>",
          "name": "<string>"
        },
        "metadata": {
          "timestamp": "2023-11-07T05:31:56Z"
        },
        "lastSyncedAt": "<string>",
        "lastStatusChangeAt": "<string>",
        "officialAccountName": "<string>",
        "accountOwnerName": "<string>",
        "mask": "<string>",
        "balance": {
          "amount": {
            "amount_cents": 123,
            "currency": "USD"
          },
          "lastBalanceCheckDate": "<string>"
        },
        "latestBalanceCheck": {
          "currentAmount": {
            "amount_cents": 123,
            "currency": "USD"
          },
          "availableAmount": {
            "amount_cents": 123,
            "currency": "USD"
          },
          "limitAmount": {
            "amount_cents": 123,
            "currency": "USD"
          }
        },
        "error": {
          "errorCode": "<string>",
          "errorType": "<string>",
          "actionMessage": "<string>",
          "userActionCta": "<string>"
        },
        "institutionLogo": "<string>"
      },
      "submittedByUser": {
        "id": "<string>",
        "name": {
          "first": "<string>",
          "last": "<string>",
          "full": "<string>"
        },
        "email": "<string>",
        "phoneNumber": "<string>",
        "last_status_change_at": "<string>",
        "verification_state": "created",
        "has_verified_email": true,
        "has_verified_phone": true,
        "has_entered_identity": true,
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "countryCode": "<string>"
        },
        "mailingAddress": {
          "addressLine": "<string>",
          "addressCity": "<string>",
          "addressState": "<string>",
          "addressZip": "<string>",
          "addressLine2": "<string>",
          "addressCountry": "<string>"
        },
        "activeIdentityEvaluationId": "<string>",
        "provider": "persona",
        "basicInfo": {
          "isResidentOfUsa": true,
          "isMinor": true
        },
        "discord": {
          "username": "<string>",
          "avatar": "<string>"
        },
        "dateOfBirth": "<string>",
        "nationalityCountryCode": "<string>"
      },
      "reviewedByUser": {
        "id": "<string>",
        "name": {
          "first": "<string>",
          "last": "<string>",
          "full": "<string>"
        },
        "email": "<string>",
        "phoneNumber": "<string>",
        "last_status_change_at": "<string>",
        "verification_state": "created",
        "has_verified_email": true,
        "has_verified_phone": true,
        "has_entered_identity": true,
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "countryCode": "<string>"
        },
        "mailingAddress": {
          "addressLine": "<string>",
          "addressCity": "<string>",
          "addressState": "<string>",
          "addressZip": "<string>",
          "addressLine2": "<string>",
          "addressCountry": "<string>"
        },
        "activeIdentityEvaluationId": "<string>",
        "provider": "persona",
        "basicInfo": {
          "isResidentOfUsa": true,
          "isMinor": true
        },
        "discord": {
          "username": "<string>",
          "avatar": "<string>"
        },
        "dateOfBirth": "<string>",
        "nationalityCountryCode": "<string>"
      },
      "review": {
        "id": "<string>",
        "expenseReportId": "<string>",
        "decision": "approved",
        "reviewedByUserId": "<string>",
        "reviewedAt": "2023-11-07T05:31:56Z",
        "timestamp": "2023-11-07T05:31:56Z",
        "rejectionReason": "<string>"
      }
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Query Parameters

cursor
string

A cursor string to fetch the next page of results

Filter by legal entity ID. Required if authenticating with access to multiple legal entities.

filter:status
enum<string>

Filter expense reports by status.

Available options:
pending_review,
cancelled,
rejected,
payment_processing,
payment_completed,
payment_failed
filter:submittedByUserId
string

Filter expense reports by the user who submitted them.

sort
enum<string>

Sort expense reports by a field. Default is by submittedAt descending.

Available options:
submittedAt,
amountCents,
transactionDate
sortDirection
enum<string>

The direction to sort by. Defaults to DESC.

Available options:
ASC,
DESC

Response

OK

items
ExpenseReportWithMetadata · object[]
required
metadata
PaginationResponse · object

Response sent when requesting a list of data