Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
bills
/
refunds
List vendor refunds
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/refunds \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "vendor-refund-123",
    "refunded_amount": 123,
    "status": "PAID",
    "completed_at": "2023-11-07T05:31:56Z",
    "allocations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "line_items": [
          {
            "external_id": "<string>",
            "amount": 123,
            "ledger_account": {
              "id": {
                "type": "AccountId",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              },
              "name": "Current Assets",
              "account_number": "4000",
              "stable_name": {
                "type": "StableName",
                "stable_name": "CURRENT_ASSETS"
              },
              "account_type": {
                "display_name": "Asset"
              },
              "account_subtype": {
                "display_name": "Current Assets"
              }
            },
            "prepayment_account": {
              "id": {
                "type": "AccountId",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              },
              "name": "Current Assets",
              "account_number": "4000",
              "stable_name": {
                "type": "StableName",
                "stable_name": "CURRENT_ASSETS"
              },
              "account_type": {
                "display_name": "Asset"
              },
              "account_subtype": {
                "display_name": "Current Assets"
              }
            },
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "bill_external_id": "<string>",
        "bill_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bill_line_item_external_id": "<string>",
        "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bill_payment_external_id": "<string>",
        "vendor": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "individual_name": "<string>",
          "company_name": "<string>",
          "email": "<string>",
          "mobile_phone": "<string>",
          "office_phone": "<string>",
          "address_string": "<string>",
          "memo": "<string>",
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "payment-456",
        "refunded_amount": 123,
        "refund_processing_fee": 123,
        "completed_at": "2023-11-07T05:31:56Z",
        "method": "ACH",
        "processor": "STRIPE",
        "payment_clearing_account": {
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Current Assets",
          "account_number": "4000",
          "stable_name": {
            "type": "StableName",
            "stable_name": "CURRENT_ASSETS"
          },
          "account_type": {
            "display_name": "Asset"
          },
          "account_subtype": {
            "display_name": "Current Assets"
          }
        },
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "memo": "<string>",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 1kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    },
    "reference_number": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs-beta.layerfi.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business to fetch vendor refunds for.

Query Parameters

​
external_id
string

Filter vendor refunds by external ID (unique idempotency key). This will always yield zero or one result.

​
status
enum<string>

Filter vendor refunds by status.

Available options:
SENT,
PARTIALLY_PAID,
PAID
​
completed_at_start
string<date-time>

Filter vendor refunds by completion date. Vendor refunds completed on or after this date will be included. ISO 8601 date format.

​
completed_at_end
string<date-time>

Filter vendor refunds by completion date. Vendor refunds completed on or before this date will be included. ISO 8601 date format.

​
min_amount
integer<int64>

Filter vendor refunds by minimum amount. Only vendor refunds with amounts greater than or equal to this value will be included. Must be a positive integer.

Required range: x >= 0
​
max_amount
integer<int64>

Filter vendor refunds by maximum amount. Only vendor refunds with amounts less than or equal to this value will be included. Must be a positive integer.

Required range: x >= 0
​
reference_numbers
string

Comma-separated list of reference numbers to filter vendor refunds by. Only vendor refunds with reference numbers matching any value in this list will be returned.

Response

List of vendor refunds

​
id
string<uuid>

Unique identifier for the vendor refund.

​
external_id
string | null

Unique ID of the vendor refund in your system for linking purposes. Idempotency key.

Example:

"vendor-refund-123"

​
refunded_amount
integer<int64>

Amount refunded to the business in cents.

​
status
string

Status of the vendor refund.

Example:

"PAID"

​
completed_at
string<date-time>

Time when the vendor refund was completed.

​
allocations
object[]

Allocations associated with this vendor refund.

​
payments
object[]

Payments associated with this vendor refund.

​
transaction_tags
object[]
​
memo
string | null

Memo for any text you would like to associate with the vendor refund (for example, to display to end users).

​
metadata
object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:
{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}
​
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the vendor refund. Can be used to filter when listing vendor refunds.