Apply Transaction 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": "<string>",
  "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",
    "credit_amount": 123,
    "metadata_": {},
    "lines": [
      {
        "description": "<string>",
        "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
        "unit_price": 123,
        "quantity": 123,
        "id": "<string>",
        "invoice_id": "<string>",
        "discount_amount": 123,
        "discount_rate": 123,
        "tax_amount": 123,
        "tax_rate": 123,
        "is_prepayment": true,
        "metadata_": {}
      }
    ],
    "payments": [
      {
        "invoice_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "invoice": "<unknown>"
      }
    ]
  }
}

POST

business

{business_id}

invoice-payment

Apply Transaction 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": "<string>",
  "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",
    "credit_amount": 123,
    "metadata_": {},
    "lines": [
      {
        "description": "<string>",
        "ledger_id": "ldg_WQMDNUHpBThYSNh4AprDBo",
        "unit_price": 123,
        "quantity": 123,
        "id": "<string>",
        "invoice_id": "<string>",
        "discount_amount": 123,
        "discount_rate": 123,
        "tax_amount": 123,
        "tax_rate": 123,
        "is_prepayment": true,
        "metadata_": {}
      }
    ],
    "payments": [
      {
        "invoice_id": "<string>",
        "transaction_id": "<string>",
        "payment_id": "<string>",
        "datetime": "2023-11-07T05:31:56Z",
        "payment_amount": 123,
        "id": "<string>",
        "invoice": "<unknown>"
      }
    ]
  }
}

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 perfomed the action

Path Parameters

business_id

string<biz_string>

required

Body

application/json

invoice_id

string<inv_string>

required

The ID of the invoice to apply payment to

transaction_id

string<txn_string>

required

The ID of the transaction to apply as payment

payment_amount

The amount to apply as payment. Defaults to the transaction amount.

Required range: x >= 0

Response

Successful Response

data

InvoicePublic · object

required

Show child attributes

data.business_id

string<biz_string>

required

The ID of the Business that the invoice is associated with

data.number

string

required

The number of the invoice. Must be unique across all invoices for a business.

Maximum string length: 255

data.description

string

required

The description of the invoice

Maximum string length: 512

data.total_amount

number

required

The amount of the invoice

data.source

enum<string>

required

The source of the invoice

Available options:

manual,

stripe

data.due_at

string<date-time>

required

The due date of the invoice

data.sent_at

string<date-time>

required

The date the invoice was sent

data.status

enum<string>

required

The status of the invoice

Available options:

open,

paid,

uncollectible,

voided,

refunded,

partially_refunded

data.id

string<inv_string>

required

The ID of the invoice

data.customer_id

string<cus_string>

required

The ID of the Customer that the invoice is associated with

data.total_paid

number

default:0

The amount of the invoice that has been paid

data.voided_at

string<date-time> | null

The date the invoice was voided

data.credit_amount

number | null

The amount to issue as a credit in the invoice

data.metadata_

Metadata · object

data.lines

InvoiceLinePublic · object[] | null

The lines of the invoice

Show child attributes

data.lines.description

string

required

The description of the line item

Maximum string length: 512

data.lines.ledger_id

string<ldg_string> | null

required

The ID of the ledger that the line item is associated with

Example:

"ldg_WQMDNUHpBThYSNh4AprDBo"

data.lines.unit_price

number

required

The unit price of the line item

data.lines.quantity

integer

required

The quantity of the line item

data.lines.id

string<inl_string>

required

The ID of the invoice line

data.lines.invoice_id

string<inv_string>

required

The ID of the invoice that the line item is associated with

data.lines.discount_amount

number | null

The discount amount of the line item

data.lines.discount_rate

number | null

The discount rate of the line item

data.lines.tax_amount

number | null

The tax amount of the line item

data.lines.tax_rate

number | null

The tax rate of the line item

data.lines.is_prepayment

boolean

Whether the line item is a prepayment

data.lines.metadata_

Metadata · object

data.payments

InvoicePaymentPublic · object[] | null

The payments of the invoice

Show child attributes

data.payments.invoice_id

string<inv_string>

required

The ID of the invoice that the payment is associated with

data.payments.transaction_id

string<txn_string>

required

The ID of the transaction that the payment is associated with

data.payments.payment_id

string

required

The external identifier of the payment

Maximum string length: 255

data.payments.datetime

string<date-time>

required

The date and time the payment was made

data.payments.payment_amount

number

required

The amount of the payment

data.payments.id

string<inp_string>

required

The ID of the invoice payment

data.payments.invoice

any | null

The invoice that the payment is associated with

Remove Invoice Payment Refund an Invoice

⌘I

API Overview

Authentication

Business

Journal Entry

Ledger

Reports

Transaction

Invoice

Bill

Request

Document

Webhooks

Apply Transaction to an Invoice

Authorizations

Headers

Path Parameters

Body

Response