Update payment
Update an invoice payment. Updates to information such as the amount or time will cause reversal of previous journal entries and creation of new entries.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The UUID of the business to update the invoice payment for.
The UUID of the invoice payment to update.
Body
An object containing a subset of Payment object fields used to update an existing Payment.
An optional external identifier for the payment.
"Unique ID of the invoice payment in an external system for linking and idempotency."
Timestamp when the payment was completed.
Customer payment amount, in cents.
Fee paid by business for processing of payment in positive cents.
List of additional fees associated with this payment.
Payment method.
CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER 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).
- Account ID
- Account Stable Name
Allocations of this payment towards invoices or ledger accounts. Setting these allocations will override any existing allocations.
Allocates a portion of the payment to a specific invoice.
- Invoice Payment Allocation
- Ledger Account Allocation
Dedicated refunds to associate with this invoice payment.
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.
Response
OK.
Unique identifier for the payment.
Unique ID of the invoice payment in an external system for linking and idempotency.
"payment-1"
Timestamp when the payment was completed.
Payment method.
CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER Fee paid by business for processing of payment in positive cents.
Identifier for the ledger account to use if this is a prepayment.
- Account ID
- Account Stable Name
The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.
List of additional fees associated with this payment.
Customer payment amount, in cents.
Processor used to make the payment, if any. Any processor name can be provided and will be tracked. Allowed only when method is CREDIT_CARD, ACH, CREDIT_BALANCE, or OTHER.
"STRIPE"
Timestamp when the payment was imported into Layer.
Allocations specify how a payment is distributed. A payment can include two types of allocations: InvoicePaymentAllocation (allocates to an invoice) and InvoicePaymentAllocationToLedgerAccount (allocates directly to a ledger account for overpayments or deposits). The sum of all allocation amounts must be less than or equal to the payment amount.
Allocates a portion of the payment to a specific invoice.
- Invoice Payment Allocation
- Ledger Account Allocation
Refund allocations associated with this invoice payment.
[]Payouts associated with this payment.
List of tags associated with this transaction.
[]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.