Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Invoice

OData end point to get a list of all invoices accessible by the user

get/api/invoice

Response

OK

currencyCodestring required

This defines the currency for this account. Must be in ISO 4217 format. Must match the currency code for the Account (contact).

dueDatestring date-time

The due date for full payment on this invoice.

expDatestring date-time

The expiration date for this quote.

amountPaidnumber double

Total amount paid. Total amount paid.

amountDuenumber double

Total amount due. Total amount due.

subnumber double

Subtotal (sum of all Items.Sub) Subtotal (sum of all Items.Sub)

discountnumber double

Indicates the total discount on this invoice. Set by DiscountPercent. Indicates the total discount on this invoice. Set by DiscountPercent.

taxnumber double

Total tax applied on this invoice (sum of all Items.Tax + Items.Tax2). Total tax applied on this invoice (sum of all Items.Tax + Items.Tax2).

totalnumber double

Total (sum of all Items.Total) Total (sum of all Items.Total)

poNumberstring
isOverdueboolean

Indicates if this invoice is overdue. Indicates if this invoice is overdue.

isExpiredboolean

Indicates if this quote has expired.

status'Saved' | 'Approved' | 'Sent' | 'Paid' | 'Viewed' | 'Overdue' | 'Expired' | 'Invoiced' | 'Due' | 'PendingApproval'

Sets the status on this invoice. Sets the status on this invoice.

approvalDatestring date-time
isApprovedboolean
createdDatestring date-time
quickbooksIdstring
guidstring uuid
numberinteger
namestring
type'Invoice' | 'Quote'

Indicates if this sale document is an Invoice or a Quote

invoiceType'Sale' | 'Refund' | 'Credit'

If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice.

datestring date-time required

The issue date for this invoice / quote.

Example response

[
  {
    "account": {
      "guid": "00000000-0000-0000-0000-000000000000"
    },
    "project": {
      "guid": "00000000-0000-0000-0000-000000000000",
      "accountGuid": "00000000-0000-0000-0000-000000000000"
    },
    "tenant": {
      "guid": "00000000-0000-0000-0000-000000000000"
    },
    "createdBy": {
      "guid": "00000000-0000-0000-0000-000000000000"
    },
    "approvedBy": {
      "guid": "00000000-0000-0000-0000-000000000000"
    },
    "guid": "00000000-0000-0000-0000-000000000000"
  }
]