{
  "platform_id": "1234567890123456789",
  "account_id": "1234567890123456789",
  "contact_id": "3770712000000080069",
  "currency_id": "3770712000000000099",
  "sales_order_ids": ["3770712000000080288"],
  "document_number": "INV-000001",
  "posted_date": "2022-09-28T00:00:00.000Z",
  "due_date": "2022-09-28T00:00:00.000Z",
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": null
    }
  },
  "currency_rate": 1,
  "status": "PAID",
  "total_discount": 10,
  "tax_amount": 0,
  "sub_total": 240,
  "total_amount": 230,
  "amount_due": 0,
  "memo": "Thanks for your business.",
  "line_items": {
    "data": [
      {
        "platform_id": "3770712000000080302",
        "item_id": "3770712000000080275",
        "tax_id": null,
        "account_id": "3770712000000000388",
        "line_item_type": "INVOICES",
        "line_item_type_id": "3770712000000080288",
        "description": null,
        "quantity": 2,
        "unit_amount": 120,
        "sub_total": 240,
        "tax_amount": 0,
        "total_amount": 240,
        "tracking_category_ids": ["5000000000000279513"],
        "Item": null,
        "tax_rate": 0,
        "total_discount": 0,
        "updated_at": "2022-09-28T00:00:00.000Z"
      }
    ]
  },
  "payments": {
    "data": [
      {
        "platform_id": "3770712000000080515",
        "payment_id": "3770712000000080513",
        "invoice_id": "3770712000000080288",
        "account_id": "3770712000000000388",
        "contact_id": "3770712000000080069",
        "amount": 120,
        "currency_id": "3770712000000000099",
        "currency": {
          "data": {
            "platform_id": "3770712000000000099",
            "name": "Indian Rupee",
            "code": "INR",
            "symbol": "₹",
            "is_base_currency": true,
            "exchange_rate": 0,
            "updated_at": null
          }
        },
        "payment_date": "2023-10-21T00:00:00.000Z",
        "payment_mode": "Cash",
        "memo": "Invoice Payment",
        "currency_rate": 1,
        "document_number": "AO-000001",
        "updated_at": "2023-10-21T00:00:00.000Z"
      }
    ]
  },
  "documents": {
    "data": [
      {
        "platform_id": "3770712000000203032_3770712000000080288",
        "file_name": "sample_upload.xlsx",
        "file_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
        "file_size": 6019.53,
        "document_type_id": "3770712000000080288",
        "document_type": "Invoices",
        "document_uploaded": false,
        "download_link": "https://books.zoho.com/api/v3/documents/3770712000000203032_3770712000000080288"
        "updated_at": "2022-09-28T00:00:00.000Z"
      }
    ]
  },
  "updated_at": "2022-09-28T00:00:00.000Z"
}

The Invoices Data Model is designed to standardise and simplify the handling of invoice-related information across different accounting platforms.

  • Unified invoice properties: The model consolidates essential invoice details, such as document number, due date, currency, status, and total amounts, making it easier to manage invoice data from various platforms.
  • Linked entities: Invoices can be associated with accounts, customers, line items, payments, and sales orders, providing a complete view of the invoicing process and related transactions.
  • Flexible status tracking: The model supports a range of invoice statuses, such as draft, submitted, partially paid, and overdue, for better organisation and reporting.

Attributes

platform_id
string
required

The accounting Platform’s ID for this invoice

account_id
string

The platform’s ID for the account to which this invoice belongs

contact_id
string

The Accounting Platform’s unique ID for the contact who receives this invoice

currency_id
string

The Accounting Platform’s unique ID for the currency

sales_order_ids
string

Array of linked Sales Orders Id associated with this Invoice

document_number
string

Reference document number for the invoice

posted_date
date

Date of the invoice as recorded by the accounting platform

due_date
date

The due date for the invoice as an ISO 8601 timestamp

currency
Object

The ISO-4217 currency

currency_rate
float

Rate between the currency of the payment and the base currency

status
enum

The status of the invoice. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN.

total_discount
float

Total value of discounts applied to the invoice

tax_amount
float

Total tax amount levied on the invoice

sub_total
float

Total pre tax value of the invoice

total_amount
float

Total value of the invoice

amount_due
float

Total amount pending for the invoice

memo
string

Description of the invoice

line_items
Line Item

Array of Invoice Line items associated with the invoice.

payments
Invoice Payment

Array of Invoice Payments associated with the Invoice.

documents
Document

Array of Invoice Documents associated with the Invoice.

raw_data
object

The raw JSON response we get from the accounting platform for that data.

updated_at
date

Date the record was last updated in the accounting platform.

Properties Supported

PropertyTypeDescription
platform_idstringThe accounting Platform’s ID for this invoice
account_idstringThe platform’s ID for the account to which this invoice belongs
contact_idstringThe Accounting Platform’s unique ID for the contact who receives this invoice
document_numberstringReference document number for the invoice
posted_datedateDate of the invoice as recorded by the accounting platform
due_datedateThe due date for the invoice as an ISO 8601 timestamp
currencystringThe ISO-4217 currency code
currency_ratefloatRate between the currency of the payment and the base currency
statusenumThe status of the invoice. Values are: DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN
total_discountfloatTotal value of discounts applied to the invoice
tax_amountfloatTotal tax amount levied on the invoice
sub_totalfloatTotal pre tax value of the invoice
total_amountfloatTotal value of the invoice
amount_duefloatTotal amount pending for the invoice
memostringDescription of the invoice
line_itemsLine ItemArray of Invoice Line items associated with the invoice (see below)
paymentsInvoice PaymentArray of Invoice Payments associated with the invoice
sales_ordersSales OrderArray of linked Sales Orders associated with this invoice
documentsDocumentArray of Invoice Documents associated with the invoice
accountAccountThe account to which this invoice belongs
contactContactThe contact who receives this invoice
updated_atdateDate the record was last updated in the accounting platform.