Skip to main content
PATCH
/
v0
/
business
/
{business_id}
/
invoice
/
{invoice_id}
Update Invoice Status
curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/invoice/{invoice_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "open"
}
'
{
  "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 performed the action

Path Parameters

business_id
string<biz_string>
required
invoice_id
string<inv_string>
required

Body

application/json
status
enum<string>
required

The new status of the invoice

Available options:
open,
paid,
uncollectible,
voided,
refunded,
partially_refunded
Examples:

"open"

"paid"

"uncollectible"

"voided"

"refunded"

"partially_refunded"

Response

Successful Response

data
InvoicePublic · object
required