v1

latestOpenAPI 3.0.02026-08-0661948.3 KB

Accounting Records

Query accounting records

Query accounting records by IDs or with filters for polling. When building integrations with Brex accounting workflow, use filter-based polling as a fallback mechanism. Suggested cadence is 1 hour.

For card and reimbursement records: Use review_status to filter by accounting workflow stage (e.g., READY_FOR_EXPORT, EXPORTED).

For bill records: Use source_type=BILL with updated_at[gt] to poll for updated bill records.

Filter Constraints:

review_status is only supported with CARD and REIMBURSEMENT source types

get/v3/accounting/records

Query parameters

idsstring[]

Filter by accounting record IDs. ID size is limited to 500. Example: ids=accr_xxx&ids=accr_yyy

review_status'PREPARE' | 'REVIEW' | 'READY_FOR_EXPORT' | 'EXPORTED'

Filter by review status. Tracks a record's stage in the accounting review lifecycle, which progresses in this order: PREPARE (the record is being prepared and is not yet ready for review) → REVIEW (the record is ready to be reviewed) → READY_FOR_EXPORT (the record has been reviewed and is queued for export to your ERP) → EXPORTED (the record has been exported).

limitnumber

Maximum number of records to return. Defaults to 100. The maximum is 500; requests with a higher value are rejected with a 400 error.

cursorstring

Cursor for pagination

single_entryboolean

Toggles the response format between single-entry and double-entry bookkeeping. Set to true to filter out offsetting ledger entries and return only the core cash-flow or economic-impact line items. Defaults to false.

gtstring date-time

Minimum value to filter by (exclusive) - ISO 8601 format

gtestring date-time

Minimum value to filter by (inclusive) - ISO 8601 format

ltstring date-time

Maximum value to filter by (exclusive) - ISO 8601 format

ltestring date-time

Maximum value to filter by (inclusive) - ISO 8601 format

Filter by updated_at timestamp range in UTC. Accepts gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal). Example: updated_at[gte]=2025-01-01

{
  "gt": "2025-01-01T00:00:00Z",
  "gte": "2025-01-01T00:00:00Z",
  "lt": "2025-01-01T00:00:00Z",
  "lte": "2025-01-01T23:59:59.999Z"
}

source_type'CARD' | 'REIMBURSEMENT' | 'BILL'

Filter by accounting record source type. This is a high-level filter that maps to specific accounting record types. Example: source_type=BILL

Response

Query accounting records response

total_countnumber nullable

Total count of records matching the query

next_cursorstring nullable

Cursor for the next page of results

has_next_pageboolean required

Whether there are more results available

Example response

{
  "items": [
    {
      "id": "accr_abc123",
      "amount": {
        "amount": 100,
        "currency": "USD"
      },
      "original_amount": {
        "amount": 100,
        "currency": "USD"
      },
      "user": {
        "id": "VXNlcjpjdXVzZXJfMTIzNA==",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "role": "CARD_ADMIN",
        "status": "ACTIVE",
        "manager_id": "VXNlcjpjdXVzZXJfMTIzNA==",
        "department_id": "VXNlcjpjdXVzZXJfMTIzNA==",
        "department_name": "Engineering",
        "location_id": "VXNlcjpjdXVzZXJfMTIzNA==",
        "location_name": "San Francisco",
        "title_id": "VGl0bGU6dGl0bGVfMTIzNA==",
        "title_name": "Software Engineer",
        "manager_first_name": "Jane",
        "manager_last_name": "Smith",
        "manager_title_id": "VGl0bGU6dGl0bGVfMTIzNA==",
        "manager_title_name": "Engineering Manager"
      },
      "vendor": {
        "id": "vendor_123",
        "name": "Acme Corp",
        "contact_name": "Jane Smith",
        "email": "contact@acme.com",
        "website": "https://acme.com",
        "phone": "+1-555-123-4567"
      },
      "line_items": [
        {
          "id": "arli_abc123",
          "amount": {
            "amount": 100,
            "currency": "USD"
          },
          "original_amount": {
            "amount": 100,
            "currency": "USD"
          },
          "accounting_field_values": [
            {
              "brex_field_id": "ef_123",
              "remote_field_id": "1",
              "brex_field_value_id": "efo_123",
              "remote_field_value_id": "123"
            }
          ]
        }
      ]
    }
  ]
}