Skip to main content
POST
/
v0
/
business
/
{business_id}
/
invoice-payment
Apply a Payment to an Invoice
curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/invoice-payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoice_id": "<string>",
  "transaction_id": "txn_oiL7THC5RDi2PVUbVyyoJ",
  "payment_amount": 1
}
'
{
  "data": {
    "business_id": "<string>",
    "number": "<string>",
    "description": "<string>",
    "total_amount": 123,
    "source": "manual",
    "due_at": "2023-11-07T05:31:56Z",
    "sent_at": "2023-11-07T05:31:56Z",
    "status": "open",
    "id": "<string>",
    "customer_id": "<string>",
    "total_paid": 0,
    "voided_at": "2023-11-07T05:31:56Z",
    "metadata_": {},
    "lines": [
      {
        "description": "<string>",
        "ledger_id": "ldg_ErisumsAc7qgmbTctM7zKK",
        "amount": 123,
        "id": "<string>",
        "invoice_id": "<string>",
        "metadata_": {}
      }
    ],
    "payments": [
      {
        "invoice_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",
        "credit_journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "credit_memo_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice": "<unknown>",
        "is_write_off": false
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getasset.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-user-id
string | null

Optional external entity identifier that performed the action

Path Parameters

​
business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Body

application/json
​
invoice_id
string<inv_string>
required

The ID of the invoice to apply payment to

Example:

"inv_Lq5AyApd4pdL1VvakpY5aJ"

​
transaction_id
string<txn_string> | null

The ID of the transaction to apply as payment. If null, the payment is drawn from the customer's available credit pool and payment_amount is required.

Example:

"txn_oiL7THC5RDi2PVUbVyyoJ"

​
payment_amount

The amount to apply as payment. When transaction_id is provided, defaults to the transaction amount. When transaction_id is null, this is required and must be greater than zero.

Required range: x >= 0

Response

Successful Response

​
data
InvoicePublic · object
required