Invoice - accountsIQ/API-Wiki GitHub Wiki

Presentation of the Invoice data structure. Invoices can be created for customers and suppliers.

Invoice

Invoice members

Name Type Description Constraints
AccountAddress1 String Get/Set the customer/supplier account address's first line.
  • Cannot be more than 50 characters
  • AccountAddress2 String Get/Set the customer/supplier account address 's second line.
  • Cannot be more than 50 characters
  • AccountBranchID Int32 Get/Set the branch account ID for a head office invoice.
    AccountID Int32 Get/Set the unique identifier of the customer/supplier.
  • Cannot be neagtive or 0.
  • AccountCode string Get the Account Code for the invoice.
    AccountName String Get/Set the customer/supplier account name. Is is duplicated here from the customer/supplier account record has it may have changed since the Invoice was created.
  • Cannot be null or empty.
  • Cannot be more than 50 characters.
  • AccountTaxCode String Get/Set the account tax code if the customer/supplier uses a default tax code. This field is used only if the UseAccountTaxCode flag is set.
  • Cannot be more than 50 characters.
  • ApprovalStatusName String Get the approval status.
    AreaID String Get/Set the area unique identifier related to the Invoice.
  • Cannot be more than 50 characters.
  • AuthorUserName String Get the name of the user who created the order.
    AuthorUserID String Get the unique identifier of the user who created the Invoice.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 8 characters long
  • City String Get/Set customer/supplier city.
  • Cannot be more than 50 characters
  • Contact String Get/Set the customer/supplier contact name.
  • Cannot be more than 50 characters
  • Country String Get/Set the customer/supplier country's name.
  • Cannot be more than 50 characters
  • County_State String Get/Set the customer/supplier county or state.
  • Cannot be more than 50 characters
  • CreationDate DateTime Get the Invoice creation date.
    CurrencyCode String Get/Set the currency code of the Invoice.
  • Cannot be more than 50 characters
  • Cannot be null.
  • Cannot be Empty
  • DeliveryAddress1 String Get/Set customer/supplier delivery address's fist line.
  • Cannot be more than 50 characters
  • DeliveryAddress2 String Get/Set customer/supplier delivery address's second line.
  • Cannot be more than 50 characters
  • DeliveryAccountName String Get/Set customer/supplier delivery account name. The delivery account name can be different from the account name.
  • Cannot be more than 50 characters long
  • DeliveryCity String Get/Set the customer/supplier delivery city.
  • Cannot be more than 50 characters long
  • DeliveryCounty_State String Get/Set customer/supplier delivery county or state.
  • Cannot be more than 50 characters long
  • DeliveryCountry String Get/Set the customer/supplier delivery country.
  • Cannot be more than 50 characters long
  • DeliveryDate DateTime Get/Set the Invoice delivery date.
    DeliveryPostCode String Get/Set the customer/supplier delivery post code.
  • Cannot be more than 50 characters long
  • DepartmentID String Get/Set the default department ID
  • Cannot be null
  • DiscountRate Decimal Get/Set the default discount rate for the Invoice.
  • Cannot be negative
  • ExchangeRate Decimal Get/Set the currency exchange rate between the customer/supplier currency and the system base currency for the current Invoice.
  • Cannot be negative or 0
  • ExcludeFromPrinting Boolean Get/Set a flag indicating whether the invoice should be included in the reports.
    ExternalApproverName String Get the name of the approver.
    ExternalReference String Get/Set the Invoice external reference.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 50 characters long
  • ForCollection Boolean Get/Set a flag indicating whether the Invoice is for collection or not.
    Hold Int16 Get/Set the hold status of the invoice. Unknown List Class
    InvoiceDate DateTime Get/Set the invoice date.
    InvoiceID Int32 Get the Invoice unique identifier.
  • Cannot be negative or 0
  • InvoiceNumber String Get/Set the Invoice number. Used only if the customer/supplier does not use auto-numbering for Invoices.
  • Cannot be null
  • Cannot be empty
  • Cannot be more than 50 characters long
  • IsPrinted Boolean Get a flag indicating whether the invoice has been printed or not.
    Ledger LedgerType Get the Invoice ledger type: Sales or Purchases.
    Lines InvoiceLine[] Get the array of lines of the Invoice. There is no limit to the amount of lines an Invoice can have.
    Notes String Get/Set some notes on the Invoice.
  • Cannot be more than 250 characters long
  • OrderDate DateTime Get/Set the order date.
    OrderID Nullable
    Int32
    Get the Order unique identifier if the Invoice has been created by promoting an Order.
    OrderNumber String Get the Order number if the Invoice has been created by promoting an Order.
  • Cannot be more than 50 characters
  • PaymentMethodID String Get/Set the customer/supplier payment method.
  • Cannot be more than 50 characters
  • Phone String Get/Set the customer/supplier phone number.
  • Cannot be more than 50 characters long
  • PostCode String Get/Set customer/supplier post code.
  • Cannot be more than 50 characters long
  • ShipmentViaID String Get/Set the ship via unique identifier.
  • Cannot be more than 50 characters long
  • Status String Get the Invoice status: Processed or Posted. A posted invoice is not editable.
    UseAccountTaxCode Boolean Get/Set a flag indicating whether the customer/supplier chooses to use the tax code from itself rather than the ones coming from the stock items. This is only useful for interactive use, on the web service this does not do anything.
  • Cannot be null
  • See Also

    InvoiceLine

    ⚠️ **GitHub.com Fallback** ⚠️