PUT
/
v1
/
businesses
/
{businessId}
/
invoices
/
{invoiceId}
curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "019234",
  "sent_at": "2023-11-07T05:31:56Z",
  "due_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z",
  "invoice_number": "1",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "<string>",
  "line_items": [
    {
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "external_id": "<string>",
      "description": "Line item description",
      "product": "Widgets",
      "unit_price": 123,
      "quantity": 123,
      "discount_amount": 123,
      "sales_taxes": [
        {
          "tax_account": {
            "type": "Tax_Name",
            "name": "CALIFORNIA_VAT"
          },
          "tax_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"
            }
          },
          "amount": 123
        }
      ],
      "is_prepayment": true,
      "dedicated_refunds": [
        {
          "external_id": "31415926535",
          "refunded_amount": 123,
          "account_identifier": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "completed_at": "2023-11-07T05:31:56Z",
          "refund_processing_fee": 123,
          "method": "CASH",
          "processor": "<string>",
          "refunded_payment_fees": [
            {
              "account": {
                "type": "AccountId",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              },
              "description": "<string>",
              "fee_amount": 123
            }
          ],
          "tags": [
            {
              "key": "Location",
              "value": "MainStreet"
            }
          ],
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 10kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          }
        }
      ]
    }
  ],
  "additional_sales_taxes": [
    {
      "tax_account": {
        "type": "Tax_Name",
        "name": "CALIFORNIA_VAT"
      },
      "tax_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"
        }
      },
      "amount": 123
    }
  ],
  "additional_discount": 123,
  "tips": 123,
  "tips_account": {
    "type": "AccountId",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "tags": [
    {
      "key": "Location",
      "value": "MainStreet"
    }
  ],
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 10kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "Invoice",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "1",
  "status": "SENT",
  "sent_at": "2023-11-07T05:31:56Z",
  "due_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z",
  "invoice_number": "1",
  "line_items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "ledger_account": {
        "id": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "name": "Current Assets",
        "stable_name": {
          "type": "StableName",
          "stable_name": "CURRENT_ASSETS"
        },
        "normality": "CREDIT",
        "account_type": {
          "value": "ASSET",
          "display_name": "Asset"
        },
        "account_subtype": {
          "value": "CURRENT",
          "display_name": "Current Assets"
        }
      },
      "description": "Widget sale",
      "product": "Widget",
      "unit_price": 123,
      "quantity": 123,
      "subtotal": 123,
      "discount_amount": 123,
      "sales_taxes_total": 123,
      "sales_taxes": [
        {
          "tax_account": {
            "type": "Tax_Name",
            "name": "CALIFORNIA_VAT"
          },
          "tax_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"
            }
          },
          "amount": 123
        }
      ],
      "total_amount": 123,
      "refund_allocations": []
    }
  ],
  "subtotal": 123,
  "additional_discount": 123,
  "additional_sales_taxes_total": 123,
  "additional_sales_taxes": [
    {
      "tax_account": {
        "type": "Tax_Name",
        "name": "CALIFORNIA_VAT"
      },
      "tax_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"
        }
      },
      "amount": 123
    }
  ],
  "tips": 123,
  "total_amount": 123,
  "outstanding_balance": 123,
  "memo": "<string>",
  "payment_allocations": [],
  "refund_allocations": [],
  "imported_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",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 10kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  }
}

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 to update the invoice for

​
invoiceId
string
required

The UUID of the invoice to update

Body

application/json

Response

200 - application/json

Invoice updated successfully

The response is of type object.