You can create invoices for any contracts with billable transactions. You can use filters to preview a set of potential invoices, then execute an invoice run based on that preview.

Note: Do not confuse a contract invoice preview with a preview snapshot, which is used for reporting purposes in the Sage Intacct UI.


List Contract Invoice Previews

readByQuery

<readByQuery>
    <object>GENINVOICEPREVIEW</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use GENINVOICEPREVIEW
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Contract Invoice Preview

read

<read>
    <object>GENINVOICEPREVIEW</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use GENINVOICEPREVIEW
keys Required string Invoice preview RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Contract Invoice Preview

create

<create>
    <GENINVOICEPREVIEW>
        <INVOICEDATE>11/02/2017</INVOICEDATE>
        <ASOFDATE>11/02/2017</ASOFDATE>
        <GLPOSTDATE>11/02/2017</GLPOSTDATE>
        <DOCPARID>Contract Invoice</DOCPARID>
        <INCLUDECONTRACTS>true</INCLUDECONTRACTS>
        <INCLUDECONTRACTUSAGE>true</INCLUDECONTRACTUSAGE>
    </GENINVOICEPREVIEW>
</create>

Parameters

Name Required Type Description
GENINVOICEPREVIEW Required string Object to create

GENINVOICEPREVIEW

Name Required Type Description
DOCPARID Required string Transaction definition to use. Definition must be enabled for Contracts.
INVOICEDATE Required string Invoice date in format mm/dd/yyyy
GLPOSTDATE Required string GL posting date in format mm/dd/yyyy
ASOFDATE Required string As of date in format mm/dd/yyyy
FILTERNAME Optional string Name of a saved filter set. To override a filter in the set, provide a value for the corresponding parameter (for example, use CONTRACTID to use the saved filter with a different contract).
BILLINGSCHSTARTDATE Optional string Start date (in format mm/dd/yyyy) when using a date range to filter for open billing. The ASOFDATE is used as the end of the range. This parameter applies only to scheduled contract billing (not usage, timesheets, expenses, AP bills, or Purchasing transactions).
PRICELISTID Optional string Billing price list ID
CONTRACTID Optional string Contract ID
CONTRACTGROUPID Optional string Contract group ID
CURRENCY Optional string Contract currency code
PROJECTID Optional string Project ID
PROJECTTYPEID Optional string Project type ID
PROJECTMANAGERID Optional string Project manager ID
EMPLOYEEID Optional string Employee ID
CUSTOMERID Optional string Customer ID
CUSTOMERTYPEID Optional string Customer type ID
ITEMID Optional string Item ID
ITEMGROUPID Optional string Item group ID
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID
INCLUDECONTRACTS Optional boolean Include contracts in the preview. Use false for No, true for Yes. (Default: false)
INCLUDECONTRACTUSAGE Optional boolean Include contract usage in the preview. Use false for No, true for Yes. (Default: false)

List Contract Invoice Preview Lines

<readByQuery>
    <object>GENINVOICEPREVIEWLINE</object>
    <fields>*</fields>
    <query>CONTRACTID='CTRC-001'</query>
    <pagesize>100</pagesize>
</readByQuery>

ReadByQuery

Name Required Type Description
object Required string Use GENINVOICEPREVIEWLINE
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Contract Invoice Preview Line

read

<read>
    <object>GENINVOICEPREVIEWLINE</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use GENINVOICEPREVIEWLINE
keys Required string Invoice preview line RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

List Contract Invoice Runs

readByQuery

<readByQuery>
    <object>GENINVOICERUN</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use GENINVOICERUN
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Contract Invoice Run

read

<read>
    <object>GENINVOICERUN</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use GENINVOICERUN
keys Required string Invoice run RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Contract Invoice Run

create

<create>
    <GENINVOICERUN>
        <PREVIEWKEY>1</PREVIEWKEY>
    </GENINVOICERUN>
</create>

Parameters

Name Required Type Description
GENINVOICERUN Required string Object to create

GENINVOICERUN

Name Required Type Description
PREVIEWKEY Required integer Invoice preview RECORDNO to use for the run
EXECUTIONMODE Optional string Execution mode for the operation. Use Online for fewer than 20 invoices or Offline for 20 or more (Default: Offline)
INVOICEMSG Optional string Message that appears on the invoice and on documents printed from the invoice

Provide feedback