Skip to main content
POST
/
v0
/
business
/
{business_id}
/
invoice
Create an Invoice
curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/invoice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "business_id": "<string>",
    "number": "<string>",
    "description": "<string>",
    "due_at": "2023-11-07T05:31:56Z",
    "sent_at": "2023-11-07T05:31:56Z",
    "customer_id": "<string>",
    "lines": [
      {
        "description": "<string>",
        "unit_price": 123,
        "quantity": 123,
        "ledger_id": "<string>",
        "discount_amount": 123,
        "discount_rate": 123,
        "tax_amount": 123,
        "tax_rate": 123,
        "is_prepayment": true,
        "metadata_": {}
      }
    ],
    "credit_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 performed the action

Path Parameters

​
business_id
string<biz_string>
required

Body

application/json
Maximum array length: 100
​
business_id
string<biz_string>
required

The ID of the Business that the invoice is associated with

​
number
string
required

The number of the invoice

​
description
string
required

The description of the invoice

​
due_at
string<date-time>
required

The due date of the invoice in ISO-8601 format

​
sent_at
string<date-time>
required

The date the invoice was sent in ISO-8601 format

​
customer_id
string<cus_string>
required

The ID of the Customer that the invoice is associated with

​
lines
InvoiceLineCreate · object[]
required

The lines of the invoice

​
credit_amount

The amount to issue as a credit in the invoice.

Required range: x >= 0

Response

Successful Response

​
data
InvoicePublic · object[]
required