Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
invoices
/
customer-credits
List customer credits
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/customer-credits \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer": {
        "type": "CustomerData",
        "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"
        }
      ],
      "type": "Customer_Credit",
      "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>"
    }
  ],
  "meta": {
    "type": "request_metadata",
    "pagination": {
      "sort_by": "<string>",
      "cursor": "<string>",
      "has_more": true,
      "total_count": 123
    }
  }
}

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 customer credits for.

Query Parameters

​
customer_id
string<uuid>

Filter customer credits by customer ID.

​
sent_at_start
string<date-time>

Filter customer credits by sent date. Customer credits received on or after this date will be included. ISO 8601 date format.

​
sent_at_end
string<date-time>

Filter customer credits by sent date. Customer credits received before this date will be included. ISO 8601 date format.

​
memo
string

Filter customer credits by exact memo match.

​
memo_contains
string

Filter customer credits where memo contains this substring.

​
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 customer credits by. Only customer credits with reference numbers matching any value in this list will be returned.

Response

200 - application/json

Success.

​
data
object[]
required
​
meta
object

Request metadata. Present on paginated list responses.