POST
/
api
/
v1
/
invoices
Create Invoice
curl --request POST \
  --url https://app.flowglad.com/api/v1/invoices \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoice": {
    "purchaseId": "<string>",
    "invoiceNumber": "<string>",
    "invoiceDate": "<string>",
    "billingPeriodId": null,
    "dueDate": "<string>",
    "customerId": "<string>",
    "status": "draft",
    "subscriptionId": null,
    "billingRunId": "<string>",
    "billingPeriodStartDate": null,
    "billingPeriodEndDate": null,
    "ownerMembershipId": "<string>",
    "pdfURL": "<string>",
    "receiptPdfURL": "<string>",
    "memo": "<string>",
    "bankPaymentOnly": true,
    "type": "<string>",
    "currency": "USD",
    "subtotal": -1,
    "taxType": "amusement_tax",
    "taxCountry": "AF",
    "taxState": "<string>"
  },
  "invoiceLineItems": [
    {
      "quantity": 123,
      "priceId": "<string>",
      "description": "<string>",
      "price": -1,
      "type": "<string>"
    }
  ],
  "autoSend": true
}'
{
  "invoice": {
    "id": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdByCommit": "<string>",
    "updatedByCommit": "<string>",
    "livemode": true,
    "purchaseId": "<string>",
    "invoiceNumber": "<string>",
    "invoiceDate": "<string>",
    "billingPeriodId": "<any>",
    "dueDate": "<string>",
    "customerId": "<string>",
    "organizationId": "<string>",
    "status": "draft",
    "subscriptionId": "<any>",
    "billingRunId": "<string>",
    "billingPeriodStartDate": "<any>",
    "billingPeriodEndDate": "<any>",
    "ownerMembershipId": "<string>",
    "pdfURL": "<string>",
    "receiptPdfURL": "<string>",
    "memo": "<string>",
    "bankPaymentOnly": true,
    "type": "<string>",
    "currency": "USD",
    "taxAmount": -1,
    "subtotal": -1,
    "taxType": "amusement_tax",
    "taxCountry": "AF",
    "taxState": "<string>",
    "taxRatePercentage": "<string>",
    "applicationFee": -1
  },
  "invoiceLineItems": [
    {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdByCommit": "<string>",
      "updatedByCommit": "<string>",
      "livemode": true,
      "invoiceId": "<string>",
      "quantity": "<any>",
      "priceId": "<string>",
      "description": "<string>",
      "price": -1,
      "type": "<string>"
    }
  ],
  "autoSend": true
}

Authorizations

Authorization
string
header
required

Body

application/json
invoice
object
required

An invoice record, which describes a bill that can be associated with a purchase, subscription, or stand alone. Each invoice has a specific type that determines its behavior and required fields.

invoiceLineItems
object[]
required
autoSend
boolean

Response

Successful response

invoice
object
required

An invoice record, which describes a bill that can be associated with a purchase, subscription, or stand alone. Each invoice has a specific type that determines its behavior and required fields.

invoiceLineItems
object[]
required
autoSend
boolean