Fetch vendor refund

curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/refunds/{refundId} \
  --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"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "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"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "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>",
        "status": "ACTIVE",
        "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"
        },
        "normality": "CREDIT",
        "account_type": {
          "value": "ASSET",
          "display_name": "Asset"
        },
        "account_subtype": {
          "value": "BANK_ACCOUNTS",
          "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>"
}

GET

businesses

{businessId}

bills

refunds

{refundId}

Fetch vendor refund

curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/refunds/{refundId} \
  --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"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "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"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "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>",
        "status": "ACTIVE",
        "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"
        },
        "normality": "CREDIT",
        "account_type": {
          "value": "ASSET",
          "display_name": "Asset"
        },
        "account_subtype": {
          "value": "BANK_ACCOUNTS",
          "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>"
}

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.

refundId

string<uuid>

required

The UUID of the vendor refund to fetch.

Response

Vendor refund details

A vendor refund represents a transaction where a vendor returns value to a business. A specific bill can be refunded or a general refund can be applied to a vendor.

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.

Show child attributes

allocations.id

string<uuid>

Unique identifier for the vendor refund allocation.

allocations.bill_id

string<uuid> | null

ID of the bill this allocation is associated with.

allocations.amount

integer<int64>

Amount of the allocation in cents.

allocations.line_items

object[]

Line items that make up this allocation.

Show child attributes

allocations.line_items.external_id

string | null

External identifier for the line item.

allocations.line_items.amount

integer<int64>

Amount of the line item in cents.

allocations.line_items.ledger_account

object

The ledger account associated with this line item.

Show child attributes

allocations.line_items.ledger_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

allocations.line_items.ledger_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

allocations.line_items.ledger_account.id.id

string<uuid>

ID of the account

allocations.line_items.ledger_account.name

string

Name of the account

Example:

"Current Assets"

allocations.line_items.ledger_account.account_number

string | null

Account number if configured

Example:

"4000"

allocations.line_items.ledger_account.stable_name

object

Show child attributes

allocations.line_items.ledger_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

allocations.line_items.ledger_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

allocations.line_items.ledger_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

allocations.line_items.ledger_account.account_type

object

Show child attributes

allocations.line_items.ledger_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

allocations.line_items.ledger_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

allocations.line_items.ledger_account.account_subtype

object

Show child attributes

allocations.line_items.ledger_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

allocations.line_items.ledger_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

allocations.line_items.prepayment_account

object

The prepayment account associated with this line item, if applicable.

Show child attributes

allocations.line_items.prepayment_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

allocations.line_items.prepayment_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

allocations.line_items.prepayment_account.id.id

string<uuid>

ID of the account

allocations.line_items.prepayment_account.name

string

Name of the account

Example:

"Current Assets"

allocations.line_items.prepayment_account.account_number

string | null

Account number if configured

Example:

"4000"

allocations.line_items.prepayment_account.stable_name

object

Show child attributes

allocations.line_items.prepayment_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

allocations.line_items.prepayment_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

allocations.line_items.prepayment_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

allocations.line_items.prepayment_account.account_type

object

Show child attributes

allocations.line_items.prepayment_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

allocations.line_items.prepayment_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

allocations.line_items.prepayment_account.account_subtype

object

Show child attributes

allocations.line_items.prepayment_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

allocations.line_items.prepayment_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

allocations.line_items.transaction_tags

object[]

Show child attributes

allocations.line_items.transaction_tags.id

string<uuid>

required

ID for the tag

allocations.line_items.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

allocations.line_items.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

allocations.line_items.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

allocations.line_items.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

allocations.line_items.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

allocations.line_items.transaction_tags.value_display_name

string | null

Display name for the tag value definition

allocations.line_items.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

allocations.line_items.memo

string | null

Memo for any text you would like to associate with the line item.

allocations.line_items.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": [] }
}

allocations.line_items.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor refund allocation line item.

allocations.bill_external_id

string | null

External ID of the bill this allocation is associated with.

allocations.bill_line_item_id

string<uuid> | null

ID of the bill line item this allocation is associated with. If specified, must not refer to a different bill than bill_id or bill_external_id.

allocations.bill_line_item_external_id

string | null

The external ID of the bill line item to refund. If specified alongside bill_line_item_id, they must refer to the same bill line item.

allocations.bill_payment_id

string<uuid> | null

ID of the bill payment this allocation is associated with.

allocations.bill_payment_external_id

string | null

External ID of the bill payment this allocation is associated with.

allocations.vendor

object

Show child attributes

allocations.vendor.id

string<uuid>

Unique identifier for the vendor.

allocations.vendor.external_id

string

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

allocations.vendor.individual_name

string | null

Full name of the individual vendor or contact at a corporate vendor.

allocations.vendor.company_name

string | null

Name of the company vendor.

allocations.vendor.email

string | null

Email address of the vendor.

allocations.vendor.mobile_phone

string | null

Mobile phone number of the vendor.

allocations.vendor.office_phone

string | null

Office phone number of the vendor.

allocations.vendor.address_string

string | null

Address of the vendor.

allocations.vendor.memo

string | null

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

allocations.vendor.status

enum<string>

Status of the vendor.

Available options:

ACTIVE,

ARCHIVED

allocations.vendor.transaction_tags

object[]

Show child attributes

allocations.vendor.transaction_tags.id

string<uuid>

required

ID for the tag

allocations.vendor.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

allocations.vendor.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

allocations.vendor.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

allocations.vendor.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

allocations.vendor.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

allocations.vendor.transaction_tags.value_display_name

string | null

Display name for the tag value definition

allocations.vendor.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

allocations.transaction_tags

object[]

Show child attributes

allocations.transaction_tags.id

string<uuid>

required

ID for the tag

allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

allocations.memo

string | null

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

allocations.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": [] }
}

allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor refund allocation.

payments

object[]

Payments associated with this vendor refund.

Show child attributes

payments.id

string<uuid>

Unique identifier for the payment.

payments.external_id

string | null

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

Example:

"payment-456"

payments.refunded_amount

integer<int64>

Amount refunded to the business in cents.

payments.refund_processing_fee

integer<int64> | null

Fee charged for the refund processing in cents.

payments.completed_at

string<date-time>

Time when the payment was completed.

payments.method

string

Method of the payment.

Example:

"ACH"

payments.processor

string | null

Processor used for the payment.

Example:

"STRIPE"

payments.payment_clearing_account

object

The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.

Show child attributes

payments.payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

payments.payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.payment_clearing_account.id.id

string<uuid>

ID of the account

payments.payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

payments.payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

payments.payment_clearing_account.stable_name

object

Show child attributes

payments.payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

payments.payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

payments.payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

payments.payment_clearing_account.account_type

object

Show child attributes

payments.payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

payments.payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

payments.payment_clearing_account.account_subtype

object

Show child attributes

payments.payment_clearing_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

payments.payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

payments.transaction_tags

object[]

Show child attributes

payments.transaction_tags.id

string<uuid>

required

ID for the tag

payments.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.memo

string | null

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

payments.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": [] }
}

payments.reference_number

string | null

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

transaction_tags

object[]

Show child attributes

transaction_tags.id

string<uuid>

required

ID for the tag

transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

transaction_tags.value_display_name

string | null

Display name for the tag value definition

transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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.

Create vendor refund Delete vendor refund

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Fetch vendor refund

Authorizations

Headers

Path Parameters

Response