Skip to main content
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
Example:
organization-id
string
required
accept
string
required

Path Parameters

id
number
required

Response

id
number
required
Example:
invoiceDate
string<date-time>
required
Example:
dueDate
string<date-time>
required
Example:
invoiceNo
string
required
Example:
customerId
number
required
Example:
entries
object[]
required
delivered
boolean
required
Example:
balance
number
required
Example:
paymentAmount
number
required
Example:
subtotal
number
required
Example:
total
number
required
Example:
dueAmount
number
required
Example:
isOverdue
boolean
required
Example:
isPartiallyPaid
boolean
required
Example:
isFullyPaid
boolean
required
Example:
createdAt
string<date-time>
required
Example:
referenceNo
string
Example:
exchangeRate
number
Example:
currencyCode
string
Example:
invoiceMessage
string
Example:
termsConditions
string
Example:
isInclusiveTax
boolean
Example:
deliveredAt
string<date-time>
Example:
warehouseId
number
Example:
branchId
number
Example:
projectId
number
Example:
attachments
object[]
paymentMethods
object[]
discount
number
Example:
discountType
enum<string>
Available options:
percentage,
amount
Example:
adjustment
number
Example:
pdfTemplateId
number
Example:
taxAmountWithheld
number
Example:
creditedAmount
number
Example:
updatedAt
string<date-time>
Example: