Record money received from a customer, spread over invoices

Before you call

Credential

Authorization: Bearer $KEY

Scope

accounting:write

Sdk

accounting.customer.receive

Cli

accounting customer receive

Request bodyapplication/json, required

• contactKeystringrequired
  At most 254 characters.
• amountMinorintegerrequired
  At most 99999999999.
• currencystringrequired
  Pattern: ^[a-z]{3}$.
• methodstring
  One of: manual, provider. Default: manual.
• receivedAtstring (date-time)
• refstring
  Default: . At most 120 characters.
• notestring
  Default: . At most 300 characters.
• allocationslist of object
  Default: [].
  • invoiceIdstring (uuid)required
  • amountMinorintegerrequired
    At most 99999999999.
• keepRemainderboolean
  Default: true.
• idempotencyKeystringrequired
  At most 120 characters.

Responses

• 200application/json
  Success
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring