Skip to main content
POST
/
v1
/
invoices
Create an Invoice
curl --request POST \
  --url https://api.bookeeping.ai/public-api/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "discount": {
    "value": 123
  },
  "invoiceDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "lineItems": [
    {
      "id": "<string>",
      "name": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "tax": {
        "value": 123
      },
      "discount": {
        "value": 123
      },
      "description": "<string>"
    }
  ],
  "note": "<string>",
  "counterParty": "<string>",
  "invoiceId": "<string>",
  "currency": "<string>",
  "purchaseOrderId": "<string>",
  "payViaStripeAccountConnectionId": "<string>"
}
'
{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "_id": "<string>",
    "projectId": "<string>",
    "invoiceId": "<string>",
    "discount": {
      "value": 123
    },
    "amount": 123,
    "invoiceDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "lineItems": [
      {
        "id": "<string>",
        "name": "<string>",
        "quantity": 123,
        "unitPrice": 123,
        "tax": {
          "value": 123
        },
        "discount": {
          "value": 123
        },
        "description": "<string>"
      }
    ],
    "note": "<string>",
    "calculated": {
      "grandTotal": 123,
      "tax": 123,
      "discount": 123,
      "subTotal": 123
    },
    "attachments": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "purchaseOrderId": "<string>",
    "counterParty": {
      "_id": "<string>",
      "accountName": "<string>",
      "accountNumber": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "otherEmails": [
        "jsmith@example.com"
      ],
      "address": {
        "city": "<string>",
        "country": "<string>",
        "state": "<string>",
        "cca2": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>"
      }
    },
    "convertedAmount": 123,
    "convertedCurrency": "<string>",
    "sendDate": "2023-11-07T05:31:56Z",
    "sendBy": "<string>",
    "cancellationReason": "<string>",
    "cancellationDate": "2023-11-07T05:31:56Z",
    "cancellationBy": "<string>",
    "paidMarkedBy": "<string>",
    "paidMarkedDate": "2023-11-07T05:31:56Z",
    "attachedTransactionId": "<string>",
    "payViaStripeAccountConnectionId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Body

application/json
​
discount
object
required

Global discount, after applying the line item discounts

​
invoiceDate
string<date-time>
required

The date of the invoice

​
dueDate
string<date-time>
required

The date of the due date

​
lineItems
object[]
required

The line items of the invoice

​
note
string
required

The notes of the invoice

​
counterParty
string
required

The id of the counterparty. Expected to be a valid object id like 666666666666666666666666

Pattern: ^[0-9A-Fa-f]{24}$
​
invoiceId
required

The id of the invoice or 'INCREMENTAL' to auto generate the invoice id

​
currency
string
required

The currency of the invoice.

​
purchaseOrderId
string | null

The id of the purchase order

​
payViaStripeAccountConnectionId
string | null

The id of the pay via stripe account connection. Expected to be a valid object id like 666666666666666666666666

Pattern: ^[0-9A-Fa-f]{24}$

Response

Create an Invoice executed successfully

​
message
string

Success message

​
metaData
object
​
data
object