Vendor credit object

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "vc001",
    "vendor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "abc123",
      "individual_name": null,
      "company_name": "Vanguard Commercial Real Estate",
      "email": null,
      "mobile_phone": null,
      "office_phone": null,
      "address_string": null,
      "notes": null,
      "status": "ACTIVE",
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": null
        }
      ]
    },
    "received_at": "2023-11-07T05:31:56Z",
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ledger_account": {
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Rent",
          "stable_name": {
            "type": "StableName",
            "stable_name": "RENT"
          },
          "normality": "DEBIT",
          "account_type": {
            "value": "EXPENSE",
            "display_name": "Expense"
          },
          "account_subtype": {
            "value": "OPERATING_EXPENSES",
            "display_name": "Operating Expenses"
          }
        },
        "amount": 123,
        "memo": null
      }
    ],
    "allocations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendor_credit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": null,
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": null
      }
    ],
    "metadata": null
  }
}

A Vendor Credit represents a transaction that reduces accounts payable to a vendor, typically due to returned goods. Each vendor credit has one or more line items specifying credited expense accounts, and zero or more allocations applying portions of the credit to bills.

Attributes

string

required

Unique identifier for the vendor credit.

string

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

Vendor object

required

The Vendor associated with this credit.

ISO8601 timestamp

required

Time when the vendor credit was received.

array of VendorCreditLineItem objects

required

Line items included in this vendor credit. See Vendor Credit Line Item Object for details.

array of VendorCreditAllocation objects

Allocations of this vendor credit to bills. See Vendor Credit Allocation Object for details.

ISO8601 timestamp

required

Time when the vendor credit was created in Layer.

ISO8601 timestamp

required

Time when the vendor credit was last updated in Layer.

ISO8601 timestamp

Time when the vendor credit was deleted, if applicable.

Array of Tags

Tags associated with the vendor credit.

Show Tag properties

string

required

The tag’s key

string

required

The tag’s value

ISO8601 timestamp

required

When the tag was created

ISO8601 timestamp

required

When the tag was last updated

ISO8601 timestamp

When the tag was deleted

json object

Arbitrary metadata you can include with the vendor credit

string

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

Vendor Credit Line Item Object

A Vendor Credit Line Item represents an individual expense account being credited by the Vendor Credit.

string

required

Unique identifier for the vendor credit line item.

SingleApiChartAccount object

Ledger account associated with this line item. This is what you’re specifying with the ‘expense_account_identifier’ in the create parameters.

integer

required

Amount for the line item in cents.

string

Description or notes for the line item.

json object

Arbitrary metadata you can include with the vendor credit line item

string

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

Vendor Credit Allocation Object

A Vendor Credit Allocation represents how a portion of a vendor credit is applied to a specific bill. By allocating vendor credits to bills, the amount owed to vendors can be reduced accordingly.

string

required

Unique identifier for the vendor credit allocation.

string

required

ID of the vendor credit this allocation belongs to.

string

required

ID of the bill this allocation is for.

integer

required

Amount of the allocation in cents.

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "vc001",
    "vendor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "abc123",
      "individual_name": null,
      "company_name": "Vanguard Commercial Real Estate",
      "email": null,
      "mobile_phone": null,
      "office_phone": null,
      "address_string": null,
      "notes": null,
      "status": "ACTIVE",
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": null
        }
      ]
    },
    "received_at": "2023-11-07T05:31:56Z",
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ledger_account": {
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Rent",
          "stable_name": {
            "type": "StableName",
            "stable_name": "RENT"
          },
          "normality": "DEBIT",
          "account_type": {
            "value": "EXPENSE",
            "display_name": "Expense"
          },
          "account_subtype": {
            "value": "OPERATING_EXPENSES",
            "display_name": "Operating Expenses"
          }
        },
        "amount": 123,
        "memo": null
      }
    ],
    "allocations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendor_credit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": null,
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": null
      }
    ],
    "metadata": null
  }
}

Remove bill payment allocation tags List vendor credits

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Vendor credit object

Attributes

Vendor Credit Line Item Object

Vendor Credit Allocation Object

​Attributes

​Vendor Credit Line Item Object

​Vendor Credit Allocation Object

Attributes

Vendor Credit Line Item Object

Vendor Credit Allocation Object