Businesses
Financial Activity
Accounting Reports
Platform Configuration
Activity Metrics
Quickbooks
curl --request POST \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/bulk \
--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",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"line_items": [
{
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"id": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "Current Assets",
"account_number": "4000",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "BANK_ACCOUNTS",
"display_name": "Current Assets"
}
},
"external_id": "<string>",
"description": "Line item description",
"product": "Widgets",
"unit_price": 123,
"quantity": 123,
"discount_amount": 123,
"sales_taxes": [
{
"tax_account": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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
}
],
"dedicated_refunds": [
{
"external_id": "31415926535",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"line_items": [
{
"amount": 123,
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"type": "AccountId",
"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>"
}
],
"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"
},
"fee_amount": 123,
"description": "<string>"
}
],
"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>"
}
],
"tags": [
{
"key": "department",
"value": "sales",
"dimension_display_name": "Department",
"value_display_name": "Sales Department"
}
]
}
],
"additional_sales_taxes": [
{
"tax_account": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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"
},
"payments": [
{
"external_id": "12345",
"method": "CASH",
"fee": 123,
"amount": 123,
"processor": "STRIPE",
"payment_clearing_account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"dedicated_refunds": [
{
"external_id": "31415926535",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"line_items": [
{
"amount": 123,
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"type": "AccountId",
"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>"
}
],
"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"
},
"fee_amount": 123,
"description": "<string>"
}
],
"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>"
}
],
"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>"
}
],
"dedicated_refunds": [
{
"external_id": "31415926535",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"line_items": [
{
"amount": 123,
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"type": "AccountId",
"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>"
}
],
"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"
},
"fee_amount": 123,
"description": "<string>"
}
],
"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>"
}
],
"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",
"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",
"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",
"account_number": "4000",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "BANK_ACCOUNTS",
"display_name": "Current Assets"
}
},
"prepayment_account": {
"id": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "Current Assets",
"account_number": "4000",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "BANK_ACCOUNTS",
"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": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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": [],
"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"
}
]
}
],
"subtotal": 123,
"additional_discount": 123,
"additional_sales_taxes_total": 123,
"additional_sales_taxes": [
{
"tax_account": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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",
"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"
}
],
"metadata": {
"custom_field": "value",
"any valid json": "below 1kb",
"nested": {
"meaning of life": 42,
"array": []
}
},
"reference_number": "<string>"
}
]Bulk create invoices
Create multiple invoices in a batch operation. This endpoint is useful for backfill use cases when creating a business with an extended invoice history. Up to 25 invoices may be uploaded per reqeust.
curl --request POST \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/bulk \
--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",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"line_items": [
{
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"id": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "Current Assets",
"account_number": "4000",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "BANK_ACCOUNTS",
"display_name": "Current Assets"
}
},
"external_id": "<string>",
"description": "Line item description",
"product": "Widgets",
"unit_price": 123,
"quantity": 123,
"discount_amount": 123,
"sales_taxes": [
{
"tax_account": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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
}
],
"dedicated_refunds": [
{
"external_id": "31415926535",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"line_items": [
{
"amount": 123,
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"type": "AccountId",
"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>"
}
],
"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"
},
"fee_amount": 123,
"description": "<string>"
}
],
"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>"
}
],
"tags": [
{
"key": "department",
"value": "sales",
"dimension_display_name": "Department",
"value_display_name": "Sales Department"
}
]
}
],
"additional_sales_taxes": [
{
"tax_account": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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"
},
"payments": [
{
"external_id": "12345",
"method": "CASH",
"fee": 123,
"amount": 123,
"processor": "STRIPE",
"payment_clearing_account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"dedicated_refunds": [
{
"external_id": "31415926535",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"line_items": [
{
"amount": 123,
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"type": "AccountId",
"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>"
}
],
"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"
},
"fee_amount": 123,
"description": "<string>"
}
],
"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>"
}
],
"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>"
}
],
"dedicated_refunds": [
{
"external_id": "31415926535",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"line_items": [
{
"amount": 123,
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"prepayment_account_identifier": {
"type": "AccountId",
"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>"
}
],
"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"
},
"fee_amount": 123,
"description": "<string>"
}
],
"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>"
}
],
"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",
"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",
"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",
"account_number": "4000",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "BANK_ACCOUNTS",
"display_name": "Current Assets"
}
},
"prepayment_account": {
"id": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "Current Assets",
"account_number": "4000",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "BANK_ACCOUNTS",
"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": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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": [],
"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"
}
]
}
],
"subtotal": 123,
"additional_discount": 123,
"additional_sales_taxes_total": 123,
"additional_sales_taxes": [
{
"tax_account": {
"name": "CALIFORNIA_VAT",
"type": "Tax_Name"
},
"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",
"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"
}
],
"metadata": {
"custom_field": "value",
"any valid json": "below 1kb",
"nested": {
"meaning of life": 42,
"array": []
}
},
"reference_number": "<string>"
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json
Path Parameters
The UUID of the business to create invoices for
Body
External ID for the invoice within your platform. Idempotency key.
"019234"
When the invoice was sent by the business to the recipient.
When the invoice is due.
When the invoice was voided. Voiding excludes the invoice entirely from accounting.
ID of the customer to associate with the invoice.
External ID of the customer to associate with the invoice.
Line items making up the invoice.
Show child attributes
Show child attributes
Ledger account for the line item used for accrual reporting. Should only be specified when this line item is a pre-payment.
Show child attributes
Show child attributes
Name of the account
"Current Assets"
Account number if configured
"4000"
CREDIT, DEBIT Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Display name of the account subtype
"Current Assets"
The external ID of the invoice line item in your system.
Description for the new invoice line item
"Line item description"
Name of the product the line item is for
"Widgets"
Show child attributes
Show child attributes
Tax account name or identifier. If not set, account defaults to top level sales tax payable liability account.
Ledger account for the tax line item
Show child attributes
Show child attributes
Name of the account
"Current Assets"
Account number if configured
"4000"
CREDIT, DEBIT Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Display name of the account subtype
"Current Assets"
{
"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, in cents, of tax owed.
Dedicated refunds to associate with this invoice line item
Show child attributes
Show child attributes
Unique ID of the refund in your system for linking purposes. Idempotency key.
"31415926535"
Optional account identifier to override what ledger account the dedicated refund comes out of.
Detailed line items for the refund allocation. Use this for itemized refunds where you need to specify the exact amounts and accounts.
Show child attributes
Show child attributes
The amount of this line item in cents.
An external identifier for the line item.
Identifier of the ledger account for this line item.
Identifier of the prepayment ledger account for this line item.
Tags to associate with the line item.
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the line item.
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund allocation line item.
When the dedicated refund was given and paid.
Fee charged to the business for processing the refund.
CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER List of fees associated with the payment for this dedicated refund. These are refunded from the payment processor rather than the business.
Show child attributes
Show child attributes
Account to which the fee should be allocated.
Amount of the fee in cents.
Description of the fee.
List of tags associated with this dedicated refund
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the refund (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund. Can be used to filter when listing refunds.
List of tags to associate with the invoice line item.
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
List of sales tax obligations on this line item.
Show child attributes
Show child attributes
Tax account name or identifier. If not set, account defaults to top level sales tax payable liability account.
Ledger account for the tax line item
Show child attributes
Show child attributes
Name of the account
"Current Assets"
Account number if configured
"4000"
CREDIT, DEBIT Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Display name of the account subtype
"Current Assets"
{
"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, in cents, of tax owed.
Additional discount applied to the whole invoice in addition to individual line items.
Tips included by the buyer, in cents.
Payments that have been made towards the balance of the invoice.
Show child attributes
Show child attributes
External ID for the payment within your platform. Idempotency key.
"12345"
Method used to make the payment.
CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER Fee associated with processing a payment, e.g. credit card processing fees, in cents.
Processor used to make the payment, if any. Any processor name can be provided and will be tracked.
"STRIPE"
The the ledger account to use for the payment (overrides the default determined by the payment method)
Dedicated refunds to associate with this invoice payment
Show child attributes
Show child attributes
Unique ID of the refund in your system for linking purposes. Idempotency key.
"31415926535"
Optional account identifier to override what ledger account the dedicated refund comes out of.
Detailed line items for the refund allocation. Use this for itemized refunds where you need to specify the exact amounts and accounts.
Show child attributes
Show child attributes
The amount of this line item in cents.
An external identifier for the line item.
Identifier of the ledger account for this line item.
Identifier of the prepayment ledger account for this line item.
Tags to associate with the line item.
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the line item.
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund allocation line item.
When the dedicated refund was given and paid.
Fee charged to the business for processing the refund.
CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER List of fees associated with the payment for this dedicated refund. These are refunded from the payment processor rather than the business.
Show child attributes
Show child attributes
Account to which the fee should be allocated.
Amount of the fee in cents.
Description of the fee.
List of tags associated with this dedicated refund
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the refund (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund. Can be used to filter when listing refunds.
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the invoice payment (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the invoice payment. Can be used to filter when listing invoice payments.
Dedicated refunds to associate with this invoice
Show child attributes
Show child attributes
Unique ID of the refund in your system for linking purposes. Idempotency key.
"31415926535"
Optional account identifier to override what ledger account the dedicated refund comes out of.
Detailed line items for the refund allocation. Use this for itemized refunds where you need to specify the exact amounts and accounts.
Show child attributes
Show child attributes
The amount of this line item in cents.
An external identifier for the line item.
Identifier of the ledger account for this line item.
Identifier of the prepayment ledger account for this line item.
Tags to associate with the line item.
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the line item.
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund allocation line item.
When the dedicated refund was given and paid.
Fee charged to the business for processing the refund.
CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER List of fees associated with the payment for this dedicated refund. These are refunded from the payment processor rather than the business.
Show child attributes
Show child attributes
Amount of the fee in cents.
Description of the fee.
List of tags associated with this dedicated refund
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the refund (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund. Can be used to filter when listing refunds.
Show child attributes
Show child attributes
The tag dimension key (e.g., "department", "project", "location")
"department"
The tag value (e.g., "sales", "marketing", "engineering")
"sales"
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.
"Department"
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.
"Sales Department"
Memo for any text you would like to associate with the invoice (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the invoice. Can be used to filter when listing invoices.
Response
Unique identifier for the invoice.
Resource type. Value will be 'Invoice'.
"Invoice"
ID of the Business that generated the invoice.
Unique ID of the invoice in your system for linking purposes.
"1"
Status of the invoice.
SENT, PARTIALLY_PAID, PAID, VOIDED, PARTIALLY_WRITTEN_OFF, WRITTEN_OFF, REFUNDED When the invoice was sent by the business to the recipient.
When the invoice is due.
When the invoice was paid.
When the invoice was voided. Voiding excludes the invoice from accounting.
Line items making up the invoice
Show child attributes
Show child attributes
ID of the invoice line item.
The external ID of the invoice line item in your system.
ID of the parent invoice
Ledger account for the line item
Show child attributes
Show child attributes
Name of the account
"Current Assets"
Account number if configured
"4000"
CREDIT, DEBIT Show child attributes
Show child attributes
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 Display name of the account subtype
"Current Assets"
Ledger account for the line item used for accrual reporting. Should only be specified when this line item is a pre-payment.
Show child attributes
Show child attributes
Name of the account
"Current Assets"
Account number if configured
"4000"
CREDIT, DEBIT Show child attributes
Show child attributes
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 Display name of the account subtype
"Current Assets"
Description for the invoice line item
"Widget sale"
Name of the product the invoice line item is for
"Widget"
The amount in cents of each unit.
Number of units sold.
Subtotal for the invoice line item in cents.
Total discount given to this line item, in cents.
Sum of amounts for all sales taxes for the line item
List of sales taxes line items
Show child attributes
Show child attributes
Tax account name or identifier. If not set, account defaults to top level sales tax payable liability account.
Ledger account for the tax line item
Show child attributes
Show child attributes
Name of the account
"Current Assets"
Account number if configured
"4000"
CREDIT, DEBIT Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Display name of the account subtype
"Current Assets"
{
"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, in cents, of tax owed.
Total amount on the line item
Refund allocations associated with this invoice line item
Show child attributes
Show child attributes
Unique identifier for the refund allocation.
ID of the invoice this allocation is associated with.
Amount of the allocation in cents.
Identifier of the ledger account for the refund allocation to apply to
External ID of the invoice this allocation is associated with.
ID of the invoice line item this allocation is associated with. If specified, must not refer to a different invoice invoice_external or invoice_id.
The external ID of the invoice line item to refund. If specified alongside invoice_line_item_id, they must refer to the same invoice line item.
ID of the invoice payment this allocation is associated with.
External ID of the invoice payment this allocation is associated with.
Show child attributes
Show child attributes
Unique identifier for the customer.
Unique ID of the customer in your system for linking purposes. Idempotency key.
"31415926535"
Full name of the individual customer or contact at a corporate customer.
Name of the company customer.
Email address of the customer.
Mobile phone number of the customer.
Office phone number of the customer.
Address of the customer.
Memo for any text you would like to associate with the customer (for example, to display to end users).
Status of the customer. Possible values: ACTIVE, ARCHIVED.
"ACTIVE"
Show child attributes
Show child attributes
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
ID of the tag dimension this tag belongs to
ID of the tag value definition
Display name for the tag dimension
Display name for the tag value definition
When the tag was archived
Show child attributes
Show child attributes
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
ID of the tag dimension this tag belongs to
ID of the tag value definition
Display name for the tag dimension
Display name for the tag value definition
When the tag was archived
Memo for any text you would like to associate with the refund allocation (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund allocation.
[]List of tags on the transaction associated with the invoice line item.
Show child attributes
Show child attributes
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
ID of the tag dimension this tag belongs to
ID of the tag value definition
Display name for the tag dimension
Display name for the tag value definition
When the tag was archived
Subtotal of all invoice line items in cents.
Additional discount applied to the whole invoice in addition to individual line items.
Sum of all taxes across the invoice line items and any additional taxes in cents.
List of additional sales tax line items
Show child attributes
Show child attributes
Tax account name or identifier. If not set, account defaults to top level sales tax payable liability account.
Ledger account for the tax line item
Show child attributes
Show child attributes
Name of the account
"Current Assets"
Account number if configured
"4000"
CREDIT, DEBIT Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Display name of the account subtype
"Current Assets"
{
"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, in cents, of tax owed.
Tips included by the buyer, in cents.
Total amount of the invoice in cents.
The remaining balance on the invoice after factoring in all previous invoice payments and write-offs.
Memo for any text you would like to associate with the Invoice (for example, to display to end users).
Payments made by a customer are allocated toward one or many invoices. This list shows which payments have been been allocated towards this invoice. The most common case is that there is a 1:1 relationship between a payment and an invoice, in which case the allocation’s amount will match the payment’s amount.
Show child attributes
Show child attributes
ID of the invoice.
ID of the payment.
Amount of the payment allocated towards this invoice. If this amount is the full payment amount, this payment was fully allocated towards this invoice. The amount cannot exceed the invoice total.
List of tags on the transaction associated with the payment allocation
Show child attributes
Show child attributes
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
ID of the tag dimension this tag belongs to
ID of the tag value definition
Display name for the tag dimension
Display name for the tag value definition
When the tag was archived
Memo for any text you would like to associate with the invoice payment allocation (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the invoice payment allocation.
[]Refunds made by a customer are allocated toward one or many invoices. This list shows which refunds have been been allocated towards this invoice.
Show child attributes
Show child attributes
Unique identifier for the refund allocation.
ID of the invoice this allocation is associated with.
Amount of the allocation in cents.
External ID of the invoice this allocation is associated with.
ID of the invoice line item this allocation is associated with. If specified, must not refer to a different invoice invoice_external or invoice_id.
The external ID of the invoice line item to refund. If specified alongside invoice_line_item_id, they must refer to the same invoice line item.
ID of the invoice payment this allocation is associated with.
External ID of the invoice payment this allocation is associated with.
Show child attributes
Show child attributes
Unique identifier for the customer.
Unique ID of the customer in your system for linking purposes. Idempotency key.
"31415926535"
Full name of the individual customer or contact at a corporate customer.
Name of the company customer.
Email address of the customer.
Mobile phone number of the customer.
Office phone number of the customer.
Address of the customer.
Memo for any text you would like to associate with the customer (for example, to display to end users).
Status of the customer. Possible values: ACTIVE, ARCHIVED.
"ACTIVE"
Show child attributes
Show child attributes
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
ID of the tag dimension this tag belongs to
ID of the tag value definition
Display name for the tag dimension
Display name for the tag value definition
When the tag was archived
Show child attributes
Show child attributes
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
ID of the tag dimension this tag belongs to
ID of the tag value definition
Display name for the tag dimension
Display name for the tag value definition
When the tag was archived
Memo for any text you would like to associate with the refund allocation (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the refund allocation.
[]Time when the invoice was first imported into Layer. Eligible sort key.
Time when the invoice was first updated in Layer. Eligible sort key.
Tags on the transactions associated with the invoice
Show child attributes
Show child attributes
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
ID of the tag dimension this tag belongs to
ID of the tag value definition
Display name for the tag dimension
Display name for the tag value definition
When the tag was archived
Arbitrary custom metadata in JSON format with a size limit of 1KB
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the invoice. Can be used to filter when listing invoices.