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 request.
Documentation Index
Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt
Use this file to discover all available pages before exploring further.
Rate Limiting
This endpoint has a custom rate limit policy. Rate Limit Details:| Environment | Limit | Refill Period | Initial Size |
|---|---|---|---|
| Sandbox | 20 requests | 1 second | 40 requests |
| Production | 20 requests | 1 second | 40 requests |
- 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
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. Either customer_id or customer_external_id must be provided.
External ID of the customer to associate with the invoice. Either customer_id or customer_external_id must be provided. If the customer does not already exist, Layer will create it using this external ID.
Line items making up the invoice.
List of additional sales tax obligations on the invoice outside individual line items.
Additional discount applied to the whole invoice in addition to individual line items.
Tips included by the buyer, in cents.
The Account Identifier for a tips account. If not specified, Layer uses the chart's default tips account, which is typically a liability account. Specify a different account if tips should be tracked as revenue.
- Account ID
- Account Stable Name
Payments that have been made towards the balance of the invoice. Include these to create an immediately paid or partially paid invoice in the same API call.
Dedicated refunds to associate with this invoice.
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.
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.
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.
[]
Refunds made by a customer are allocated toward one or many invoices. This list shows which refunds have been been allocated towards this invoice.
[]
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.
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.