Create vendor credit

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/vendor-credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "received_at": "2023-11-07T05:31:56Z",
  "line_items": [
    {
      "amount": 123,
      "expense_account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>",
      "tags": [
        {
          "key": "department",
          "value": "sales",
          "dimension_display_name": "Department",
          "value_display_name": "Sales Department"
        }
      ]
    }
  ],
  "external_id": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_external_id": "<string>",
  "allocations": [
    {
      "amount": 123,
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'

{
  "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>",
    "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"
      }
    ]
  },
  "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"
        },
        "normality": "CREDIT",
        "account_type": {
          "value": "ASSET",
          "display_name": "Asset"
        },
        "account_subtype": {
          "value": "BANK_ACCOUNTS",
          "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>"
}

POST

businesses

{businessId}

bills

vendor-credits

Create vendor credit

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/bills/vendor-credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "received_at": "2023-11-07T05:31:56Z",
  "line_items": [
    {
      "amount": 123,
      "expense_account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>",
      "tags": [
        {
          "key": "department",
          "value": "sales",
          "dimension_display_name": "Department",
          "value_display_name": "Sales Department"
        }
      ]
    }
  ],
  "external_id": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_external_id": "<string>",
  "allocations": [
    {
      "amount": 123,
      "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'

{
  "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>",
    "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"
      }
    ]
  },
  "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"
        },
        "normality": "CREDIT",
        "account_type": {
          "value": "ASSET",
          "display_name": "Asset"
        },
        "account_subtype": {
          "value": "BANK_ACCOUNTS",
          "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 create the vendor credit for

Body

application/json

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

Show child attributes

line_items.amount

integer<int64>

required

Amount for the line item in cents.

line_items.expense_account_identifier

Account ID · object

required

Identifier for the expense account for the vendor credit line item. It is suggested but not required that this should point to an expense account (as opposed to revenue/asset/liability/equity)

Account ID
Account Stable Name

Show child attributes

line_items.expense_account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

line_items.expense_account_identifier.id

string<uuid>

ID of the account

line_items.memo

string

Description for the line item

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

line_items.reference_number

string | null

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

line_items.tags

object[]

List of tags associated with this vendor credit line item

Show child attributes

line_items.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

line_items.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

line_items.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

line_items.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

external_id

string

External identifier for the vendor credit

vendor_id

string<uuid>

UUID of the vendor this credit is associated with

vendor_external_id

string

External identifier of the vendor this credit is associated with

allocations

object[]

List of allocations for this vendor credit

Show child attributes

allocations.amount

integer<int64>

required

Amount for the allocation in cents.

allocations.bill_id

string<uuid>

required

UUID of the bill the vendor credit allocation is for

Response

Existing vendor credit found or updated

string<uuid>

required

Unique identifier for the vendor credit

vendor

object

required

The vendor associated with this credit

Show child attributes

vendor.id

string<uuid>

Unique identifier for the vendor.

vendor.external_id

string

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

vendor.individual_name

string | null

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

vendor.company_name

string | null

Name of the company vendor.

vendor.email

string | null

Email address of the vendor.

vendor.mobile_phone

string | null

Mobile phone number of the vendor.

vendor.office_phone

string | null

Office phone number of the vendor.

vendor.address_string

string | null

Address of the vendor.

vendor.memo

string | null

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

vendor.status

enum<string>

Status of the vendor.

Available options:

ACTIVE,

ARCHIVED

vendor.transaction_tags

object[]

Show child attributes

vendor.transaction_tags.id

string<uuid>

required

ID for the tag

vendor.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

vendor.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

vendor.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

vendor.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

vendor.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

vendor.transaction_tags.value_display_name

string | null

Display name for the tag value definition

vendor.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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

Show child attributes

line_items.id

string<uuid>

required

Unique identifier for the vendor credit line item

line_items.amount

integer<int64>

required

Amount for the line item in cents

line_items.ledger_account

object

Ledger account for this line item

Show child attributes

line_items.ledger_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

line_items.ledger_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

line_items.ledger_account.id.id

string<uuid>

ID of the account

line_items.ledger_account.name

string

Name of the account

Example:

"Current Assets"

line_items.ledger_account.account_number

string | null

Account number if configured

Example:

"4000"

line_items.ledger_account.stable_name

object

Show child attributes

line_items.ledger_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

line_items.ledger_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

line_items.ledger_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

line_items.ledger_account.account_type

object

Show child attributes

line_items.ledger_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

line_items.ledger_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

line_items.ledger_account.account_subtype

object

Show child attributes

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

line_items.ledger_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

line_items.memo

string

Description for the line item

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

line_items.reference_number

string | null

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

line_items.transaction_tags

object[]

List of tags associated with this vendor credit line item

Show child attributes

line_items.transaction_tags.id

string<uuid>

required

ID for the tag

line_items.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

line_items.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

line_items.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

line_items.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

line_items.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

line_items.transaction_tags.value_display_name

string | null

Display name for the tag value definition

line_items.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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

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

external_id

string

External identifier for the vendor credit

allocations

object[]

List of allocations for this vendor credit

Show child attributes

allocations.id

string<uuid>

required

Unique identifier for the vendor credit allocation

allocations.vendor_credit_id

string<uuid>

required

UUID of the vendor credit this allocation belongs to

allocations.amount

integer<int64>

required

Amount for the allocation in cents

allocations.bill_id

string<uuid>

UUID of the bill this allocation is for

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.

List vendor credits Fetch vendor credit

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Create vendor credit

Authorizations

Path Parameters

Body

Response