GET
/
api
/
sale-invoices
/
{id}
{
  "id": 1,
  "invoiceDate": "2023-01-01T00:00:00Z",
  "dueDate": "2023-01-15T00:00:00Z",
  "invoiceNo": "INV-001",
  "referenceNo": "REF-001",
  "customerId": 1,
  "exchangeRate": 1,
  "currencyCode": "USD",
  "invoiceMessage": "Thank you for your business",
  "termsConditions": "Payment due within 14 days",
  "isInclusiveTax": false,
  "entries": [
    {
      "index": 1,
      "itemId": 1,
      "rate": 1,
      "quantity": 1,
      "discount": 1,
      "discountType": "percentage",
      "description": "This is a description",
      "taxCode": "123456",
      "taxRateId": 1,
      "warehouseId": 1,
      "projectId": 1,
      "projectRefId": 1,
      "projectRefType": "TASK",
      "projectRefInvoicedAmount": 100,
      "sellAccountId": 1020,
      "costAccountId": 1021
    }
  ],
  "delivered": false,
  "deliveredAt": "2023-01-02T00:00:00Z",
  "warehouseId": 1,
  "branchId": 1,
  "projectId": 1,
  "attachments": [
    {}
  ],
  "paymentMethods": [
    {
      "paymentIntegrationId": 1,
      "enable": true
    }
  ],
  "discount": 10,
  "discountType": "percentage",
  "adjustment": 5,
  "pdfTemplateId": 1,
  "taxAmountWithheld": 50,
  "balance": 1000,
  "paymentAmount": 500,
  "creditedAmount": 0,
  "subtotal": 900,
  "total": 1000,
  "dueAmount": 500,
  "isOverdue": false,
  "isPartiallyPaid": true,
  "isFullyPaid": false,
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z"
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

​
accept
string
required

Path Parameters

​
id
number
required

The sale invoice id

Response

The sale invoice details have been successfully retrieved.

​
id
number
required

The unique identifier of the sale invoice

Example:

1

​
invoiceDate
string<date-time>
required

The date of the invoice

Example:

"2023-01-01T00:00:00Z"

​
dueDate
string<date-time>
required

The due date of the invoice

Example:

"2023-01-15T00:00:00Z"

​
invoiceNo
string
required

The invoice number

Example:

"INV-001"

​
customerId
number
required

The ID of the customer

Example:

1

​
entries
object[]
required

The line items of the invoice

​
delivered
boolean
required

Whether the invoice has been delivered

Example:

false

​
balance
number
required

The balance of the invoice

Example:

1000

​
paymentAmount
number
required

The amount paid

Example:

500

​
subtotal
number
required

The subtotal amount before tax and adjustments

Example:

900

​
total
number
required

The total amount including tax and adjustments

Example:

1000

​
dueAmount
number
required

The due amount remaining to be paid

Example:

500

​
isOverdue
boolean
required

Whether the invoice is overdue

Example:

false

​
isPartiallyPaid
boolean
required

Whether the invoice is partially paid

Example:

true

​
isFullyPaid
boolean
required

Whether the invoice is fully paid

Example:

false

​
createdAt
string<date-time>
required

The date when the invoice was created

Example:

"2023-01-01T00:00:00Z"

​
referenceNo
string

The reference number

Example:

"REF-001"

​
exchangeRate
number

The exchange rate for currency conversion

Example:

1

​
currencyCode
string

The currency code

Example:

"USD"

​
invoiceMessage
string

Custom message on the invoice

Example:

"Thank you for your business"

​
termsConditions
string

Terms and conditions of the invoice

Example:

"Payment due within 14 days"

​
isInclusiveTax
boolean

Whether tax is inclusive in the item rates

Example:

false

​
deliveredAt
string<date-time>

The date when the invoice was delivered

Example:

"2023-01-02T00:00:00Z"

​
warehouseId
number

The ID of the warehouse

Example:

1

​
branchId
number

The ID of the branch

Example:

1

​
projectId
number

The ID of the project

Example:

1

​
attachments
object[]

The attachments of the invoice

​
paymentMethods
object[]

The payment methods associated with the invoice

​
discount
number

The discount value

Example:

10

​
discountType
enum<string>

The type of discount (percentage or fixed)

Available options:
percentage,
amount
Example:

"percentage"

​
adjustment
number

The adjustment amount

Example:

5

​
pdfTemplateId
number

The ID of the PDF template

Example:

1

​
taxAmountWithheld
number

The total amount of tax withheld

Example:

50

​
creditedAmount
number

The amount credited

Example:

0

​
updatedAt
string<date-time>

The date when the invoice was last updated

Example:

"2023-01-02T00:00:00Z"