Skip to main content
POST
/
receivables
Create receivable
curl --request POST \
  --url https://api.allcovered.xyz/v1/receivables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoice_number": "<string>",
  "amount": 1.01,
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_name": "<string>",
  "customer_email": "[email protected]",
  "due_date": "2023-12-25",
  "notes": "<string>",
  "send_immediately": false
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoice_number": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_name": "<string>",
    "customer_email": "[email protected]",
    "amount": 123,
    "currency": "USD",
    "due_date": "2023-12-25",
    "status": "draft",
    "notes": "<string>",
    "sent_at": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
Create a new receivable (customer invoice).

Authorizations

​
Authorization
string
header
required

API key from StableBase dashboard

Body

application/json
​
invoice_number
string
required
​
amount
number<decimal>
required
Required range: x >= 0.01
​
customer_id
string<uuid>
​
customer_name
string
​
customer_email
string<email>
​
due_date
string<date>
​
notes
string
​
send_immediately
boolean
default:false

Send the invoice to the customer immediately

Response

Receivable created

​
data
object
required