Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
bills
/
vendor-credits
List vendor credits
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/vendor-credits \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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"
        }
      ]
    },
    "received_at": "2023-11-07T05:31:56Z",
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "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"
          }
        },
        "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"
          }
        ]
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_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"
      }
    ],
    "external_id": "<string>",
    "allocations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendor_credit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "deleted_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.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business to fetch vendor credits for.

Query Parameters

​
vendor_id
string<uuid>

Filter vendor credits by vendor ID.

​
received_at_start
string<date-time>

Filter vendor credits by received date. Vendor credits received on or after this date will be included. ISO 8601 date format.

​
received_at_end
string<date-time>

Filter vendor credits by received date. Vendor credits received on or before this date will be included. ISO 8601 date format.

​
reference_number
string

Filter by exact reference number match. Returns only records with this exact reference number.

​
reference_numbers
string

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

​
memo
string

Filter vendor credits by exact memo match.

​
memo_contains
string

Filter vendor credits where memo contains this substring.

Response

200 - application/json

Success.

​
id
string<uuid>
required

Unique identifier for the vendor credit.

​
vendor
object
required

The vendor associated with this credit.

​
received_at
string<date-time>
required

Timestamp when the vendor credit was received.

​
line_items
object[]
required

List of line items for this vendor credit.

​
created_at
string<date-time>
required

Timestamp when the vendor credit was created.

​
updated_at
string<date-time>
required

Timestamp when the vendor credit was last updated.

​
transaction_tags
object[]
required

List of tags associated with this vendor credit.

​
external_id
string

External identifier for the vendor credit.

​
allocations
object[]

List of allocations for this vendor credit.

​
deleted_at
string<date-time>

Timestamp when the vendor credit was deleted, if applicable.

​
memo
string | null

Memo for any text you would like to associate with the vendor credit (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 credit. Can be used to filter when listing vendor credits.