Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
invoices
/
{invoiceId}
/
write-off
Record write-off
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/{invoiceId}/write-off \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "amount": 123,
  "memo": "<string>",
  "destination_ledger_account": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "write_off_at": "2023-11-07T05:31:56Z",
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ]
}
'
{
  "data": {
    "type": "Api_Invoice_Write_Off",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "amount": 123,
    "memo": "<string>",
    "destination_ledger_account": {
      "type": "AccountId",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "write_off_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"
      }
    ]
  }
}

​
Rate Limiting

This endpoint has a custom rate limit policy. Rate Limit Details:
EnvironmentLimitRefill PeriodInitial Size
Sandbox5 requests1 second5 requests
Production25 requests1 second25 requests
Response Headers: All responses include the following rate limit headers:
  • X-RateLimit-Limit: The rate limit bucket capacity
  • X-RateLimit-Remaining: The number of tokens remaining in the bucket
  • X-RateLimit-Reset: UTC timestamp (in seconds) when the bucket will be refilled
For more details on rate limiting, see Rate Limiting.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

​
businessId
string
required

The UUID of the business the invoice is associated with.

​
invoiceId
string
required

The UUID of the invoice the write-off is applied to.

Body

application/json
​
external_id
string | null

Unique ID of the write-off in your system for linking and idempotency.

​
amount
integer<int64>

The amount written off. This amount counts towards the invoice total and decreases the outstanding balance of the invoice. The amount is optional if omitted, default to the entire outstanding balance of the invoice. If specified, the amount must be a positive value and cannot exceed the current outstanding balance of the invoice.

​
memo
string | null

User-specified memo indicating the reason for the write-off. Recommended but not required.

​
destination_ledger_account
Account ID · object

Expense or contra-revenue account where write off amount is recorded. See AccountIdentifier for more details. This field is optional and defaults to the bad debt expense account. If the write-off is for a different reason, such as a charitable donation, a different ledger expense account can be specified here.

​
write_off_at
string<date-time>

Timestamp when the write off should be recognized in the general ledger.

​
tags
object[]

Response

​
data
object
required