Get All Invoices - Bookeeping.ai Docs

GET

invoices

Get All Invoices

curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/invoices \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "invoices": [
      {
        "_id": "<string>",
        "projectId": "<string>",
        "status": "DRAFT",
        "invoiceId": "<string>",
        "discount": {},
        "amount": 123,
        "invoiceDate": "2023-11-07T05:31:56Z",
        "dueDate": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "lineItems": [
          {}
        ],
        "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>",
          "type": "customer",
          "otherEmails": [
            "jsmith@example.com"
          ],
          "address": {}
        },
        "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>"
      }
    ],
    "count": 123
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

page

string

The page number 1 - n

limit

string

The number of items per page. Max is 250. Default is 10.

sortKey

enum<string>

The key to sort the items by. Default is _id.

Available options:

_id,

name,

createdAt,

updatedAt,

transactionDate

sortOrder

enum<string>

The order to sort the items by. Default is 1. -1 for descending. 1 for ascending.

Available options:

1,

-1

minAmount

string

Minimum amount. Expected to be a number string (Int or Float) eg: 1000,1000.5

maxAmount

string

Maximum amount. Expected to be a number string (Int or Float) eg: 1000,1000.5

startDate

string<date-time>

Start date in ISO format

endDate

string<date-time>

End date in ISO format

counterparties

string

Includes counterparties ids. Comma separated list of object ids eg: 666666666666666666666666,666666666666666666666666

invoiceStatuses

string

Includes invoice statuses. Comma separated list of invoice statuses eg: DRAFT,SENT,PAID,OVERDUE,CANCELLED

Response

Get All Invoices executed successfully

message

string

Success message

metaData

object

Show child attributes

metaData.warnings

string[]

Any validation warnings

data

object

Show child attributes

data.invoices

object[]

required

The invoices

Show child attributes

data.invoices._id

string

required

The id of the invoice

data.invoices.projectId

string

required

The id of the project

data.invoices.status

enum<string>

required

The status of the invoice

Available options:

DRAFT,

SENT,

PAID,

OVERDUE,

CANCELLED

data.invoices.invoiceId

string

required

The number of the invoice eg. 0001, 0002, etc.

data.invoices.discount

object

required

Global discount, after applying the line item discounts

data.invoices.amount

number

required

The amount of the invoice

data.invoices.invoiceDate

string<date-time>

required

The date of the invoice

data.invoices.dueDate

string<date-time>

required

The date of the due date

data.invoices.currency

string

required

The currency of the invoice

data.invoices.lineItems

object[]

required

The line items of the invoice

data.invoices.note

string

required

The notes of the invoice

data.invoices.calculated

object

required

Show child attributes

data.invoices.calculated.grandTotal

number

required

The grand total of the invoice

data.invoices.calculated.tax

number

required

The tax of the invoice

data.invoices.calculated.discount

number

required

The discount of the invoice

data.invoices.calculated.subTotal

number

required

The sub total of the invoice

data.invoices.attachments

string[]

required

The attachments of the invoice

data.invoices.createdAt

string<date-time>

required

The date of the creation

data.invoices.updatedAt

string<date-time>

required

The date of the last update

data.invoices.purchaseOrderId

string | null

data.invoices.counterParty

object

Show child attributes

data.invoices.counterParty._id

string

required

The id of the counterparty

data.invoices.counterParty.accountName

string | null

data.invoices.counterParty.accountNumber

string | null

data.invoices.counterParty.email

string<email> | null

data.invoices.counterParty.phone

string | null

data.invoices.counterParty.type

enum<string> | null

Available options:

customer,

vendor,

both

data.invoices.counterParty.otherEmails

string<email>[] | null

data.invoices.counterParty.address

object

The address of the counterparty

data.invoices.convertedAmount

number | null

data.invoices.convertedCurrency

string | null

data.invoices.sendDate

string<date-time> | null

data.invoices.sendBy

string | null

data.invoices.cancellationReason

string | null

data.invoices.cancellationDate

string<date-time> | null

data.invoices.cancellationBy

string | null

data.invoices.paidMarkedBy

string | null

data.invoices.paidMarkedDate

string<date-time> | null

data.invoices.attachedTransactionId

string | null

data.invoices.payViaStripeAccountConnectionId

string | null

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

data.count

number

required

The count of the invoices

Create an InvoiceCreate an Invoice

⌘I

Get All Invoices

curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/invoices \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "invoices": [
      {
        "_id": "<string>",
        "projectId": "<string>",
        "status": "DRAFT",
        "invoiceId": "<string>",
        "discount": {},
        "amount": 123,
        "invoiceDate": "2023-11-07T05:31:56Z",
        "dueDate": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "lineItems": [
          {}
        ],
        "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>",
          "type": "customer",
          "otherEmails": [
            "jsmith@example.com"
          ],
          "address": {}
        },
        "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>"
      }
    ],
    "count": 123
  }
}

Routes

Authorizations

Query Parameters

Response