Skip to main content
POST
/
v1
/
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.

​
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.

​
tags
object[]

List of tags associated with this customer credit.

​
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.

Response

Existing customer credit found or updated.

​
id
string<uuid>
required

Unique identifier for the customer credit.

​
customer
object
required

The customer associated with this credit.

​
line_items
object[]
required

List of line items for this customer credit.

​
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.

​
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.

​
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.