Create customer credit

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/customer-credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "line_items": [
    {
      "amount": 123,
      "revenue_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>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "<string>",
  "sent_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "amount": 123,
      "invoice_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",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "31415926535",
    "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"
      }
    ]
  },
  "line_items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "ledger_account": {
        "id": "c4007474-f604-4d57-9690-b7f40f7a1cee",
        "name": "Sales tax: CALIFORNIA",
        "stable_name": "SALES_TAXES_PAYABLE:CALIFORNIA",
        "normality": "CREDIT",
        "account_type": {
          "value": "LIABILITY",
          "display_name": "Liabilities"
        },
        "account_subtype": {
          "value": "SALES_TAXES_PAYABLE",
          "display_name": "Sales Taxes Payable"
        }
      },
      "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>",
  "sent_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_credit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "invoice_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}

invoices

customer-credits

Create customer credit

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/customer-credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "line_items": [
    {
      "amount": 123,
      "revenue_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>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "<string>",
  "sent_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "amount": 123,
      "invoice_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",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "31415926535",
    "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"
      }
    ]
  },
  "line_items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "ledger_account": {
        "id": "c4007474-f604-4d57-9690-b7f40f7a1cee",
        "name": "Sales tax: CALIFORNIA",
        "stable_name": "SALES_TAXES_PAYABLE:CALIFORNIA",
        "normality": "CREDIT",
        "account_type": {
          "value": "LIABILITY",
          "display_name": "Liabilities"
        },
        "account_subtype": {
          "value": "SALES_TAXES_PAYABLE",
          "display_name": "Sales Taxes Payable"
        }
      },
      "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>",
  "sent_at": "2023-11-07T05:31:56Z",
  "allocations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_credit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "invoice_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 customer credit for

Body

application/json

line_items

object[]

required

List of line items for this customer credit

Show child attributes

line_items.amount

integer<int64>

required

Amount for the line item in cents.

line_items.revenue_account_identifier

Account ID · object

required

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

Account ID
Account Stable Name

Show child attributes

line_items.revenue_account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

line_items.revenue_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 customer credit. Can be used to filter when listing customer credits.

line_items.tags

object[]

List of tags associated with this customer 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 customer credit

customer_id

string<uuid>

UUID of the customer this credit is associated with

customer_external_id

string

External identifier of the customer this credit is associated with

sent_at

string<date-time>

Timestamp when the customer credit was sent

allocations

object[]

List of allocations for this customer credit

Show child attributes

allocations.amount

integer<int64>

required

Amount for the allocation in cents.

allocations.invoice_id

string<uuid>

required

UUID of the invoice the customer credit allocation is for

Response

Existing customer credit found or updated

string<uuid>

required

Unique identifier for the customer credit

customer

object

required

The customer associated with this credit

Show child attributes

customer.id

string<uuid>

Unique identifier for the customer.

customer.external_id

string

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

Example:

"31415926535"

customer.individual_name

string | null

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

customer.company_name

string | null

Name of the company customer.

customer.email

string | null

Email address of the customer.

customer.mobile_phone

string | null

Mobile phone number of the customer.

customer.office_phone

string | null

Office phone number of the customer.

customer.address_string

string | null

Address of the customer.

customer.memo

string | null

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

customer.status

string

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Example:

"ACTIVE"

customer.transaction_tags

object[]

Show child attributes

customer.transaction_tags.id

string<uuid>

required

ID for the tag

customer.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

customer.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

customer.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

customer.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

customer.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

customer.transaction_tags.value_display_name

string | null

Display name for the tag value definition

customer.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

line_items

object[]

required

List of line items for this customer credit

Show child attributes

line_items.id

string<uuid>

required

Unique identifier for the customer 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"

Example:

{
  "id": "c4007474-f604-4d57-9690-b7f40f7a1cee",
  "name": "Sales tax: CALIFORNIA",
  "stable_name": "SALES_TAXES_PAYABLE:CALIFORNIA",
  "normality": "CREDIT",
  "account_type": {
    "value": "LIABILITY",
    "display_name": "Liabilities"
  },
  "account_subtype": {
    "value": "SALES_TAXES_PAYABLE",
    "display_name": "Sales Taxes Payable"
  }
}

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 customer credit line item.

line_items.transaction_tags

object[]

List of tags associated with this customer 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 customer credit was created

updated_at

string<date-time>

required

Timestamp when the customer credit was last updated

transaction_tags

object[]

required

List of tags associated with this customer 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 customer credit

sent_at

string<date-time>

Timestamp when the customer credit was sent

allocations

object[]

List of allocations for this customer credit

Show child attributes

allocations.id

string<uuid>

required

Unique identifier for the customer credit allocation

allocations.customer_credit_id

string<uuid>

required

UUID of the customer credit this allocation belongs to

allocations.amount

integer<int64>

required

Amount for the allocation in cents

allocations.invoice_id

string<uuid>

UUID of the invoice this allocation is for

deleted_at

string<date-time>

Timestamp when the customer credit was deleted, if applicable

memo

string | null

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

List customer credits Fetch customer credit

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Create customer credit

Authorizations

Path Parameters

Body

Response