An AP recurring bill provides the ability to schedule and automate the process of creating AP bills. It is commonly used for regularly-recurring, fixed-amount bills.


Get Recurring Bill Object Definition

lookup

List all the fields and relationships for the recurring bill object:

<lookup>
    <object>APRECURBILL</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use APRECURBILL

List Recurring Bills

query

List the record number and vendor name for each recurring bill where the vendor name starts with the letter B:

<query>
    <object>APRECURBILL</object>
    <select>
        <field>RECORDNO</field>
        <field>VENDORNAME</field>
    </select>
    <filter>
        <like>
            <field>VENDORNAME</field>
            <value>B%</value>
        </like>
    </filter>
</query>

Parameters

Name Required Type Description
object Required string Use APRECURBILL
select Required sequence One or more field names and an optional aggregate function such as count or sum. Returning all fields is not supported.
filter Optional object Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
        <field>RECORDNO</field>
        <descending/>
</order>
options Optional object Set the caseinsensitive element to true for a case-insensitive query:
    <caseinsensitive>true</caseinsensitive>
In a multi-entity company, set the showprivate element to true to query data in private entities:
   <showprivate>true</showprivate>
pagesize Optional integer Custom page size between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

List Recurring Bills (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APRECURBILL
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. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Recurring Bill

read

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

Parameters

Name Required Type Description
object Required string Use APRECURBILL
keys Required string Recurring bill 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 Recurring Bill (Legacy)

Release Changes
2020 Release 2 Added costtypeid
2019 Release 4 Added taskid

create_recurringbill

<create_recurringbill>
    <vendorid>V1234</vendorid>
    <datecreated>
        <year>2017</year>
        <month>04</month>
        <day>10</day>
    </datecreated>
    <recordid>Recurring Rent</recordid>
    <docnumber>5678</docnumber>
    <description>Monthly rent</description>
    <termname>Net 10</termname>
    <startdate>
        <year>2017</year>
        <month>01</month>
        <day>01</day>
    </startdate>
    <ending>
        <occur>12</occur>
    </ending>
    <modenew>Months</modenew>
    <interval>12</interval>
    <eom>true</eom>
    <recurbillitems>
        <recurlineitem>
            <glaccountno>6500</glaccountno>
            <amount>1000.00</amount>
            <locationid>LAX-US</locationid>
            <departmentid>ADM</departmentid>
        </recurlineitem>
    </recurbillitems>
</create_recurringbill>

Parameters

Name Required Type Description
vendorid Required string Vendor ID
datecreated Required object Transaction date. Make this match Start date.
recordid Optional string Bill sequence number
docnumber Optional string Reference number
description Optional string Description
contractid Optional string Contract ID
contractdesc Optional string Contract description
termname Required string Payment term
currency Optional string Transaction currency code
exchratedate Optional object Exchange rate date.
exchratetype Optional string Exchange rate type. Do not use if exchrate is set. (Leave blank to use Intacct Daily Rate)
exchrate Optional currency Exchange rate value. Do not use if exchangeratetype is set.
status Optional string Status. Use active or inactive. (Default: active)
supdocid Optional string Attachments ID
paytocontactname Optional string Pay to contact name
returntocontactname Optional string Return to contact name
startdate Required object Start date
ending Optional object Ending on. Leave element out to Never end.
modenew Optional string Repeat mode. Use None, Days, Weeks, Months, or Years. (Default: None)
interval Optional integer Repeat interval. Required when Repeat mode is not set to None.
eom Optional boolean End of month. Only used when Repeat mode is set to Months. Use either true or false. (Default: false)
recurbillitems Required recurlineitem[1...n] Bill lines, must have at least 1.

datecreated

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

exchratedate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

startdate

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

recurlineitem

Name Required Type Description
glaccountno Optional string GL account number. Required if not using accountlabel.
accountlabel Optional string AP account label. Required if not using glaccountno.
form1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be set up for 1099s.
amount Required currency Transaction amount
memo Optional string Memo
locationid Optional string Location ID
departmentid Optional string Department ID
projectid Optional string Project ID
taskid Optional string Task ID. Only available when the parent projectid is also specified.
costtypeid Optional string Cost type ID. Only available when projectid and taskid are specified. (Construction subscription)
customerid Optional string Customer ID
vendorid Optional string Vendor ID
employeeid Optional string Employee ID
itemid Optional string Item ID
classid Optional string Class ID
contractid Optional string Contract ID
warehouseid Optional string Warehouse ID
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)
customfields Optional customfield[0...n] Custom fields

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

Delete Recurring Bill (Legacy)

delete_bill

<delete_recurringbill key="1234"></delete_recurringbill>

Parameters

Name Required Type Description
key Required string Recurring bill RECORDNO to delete

Get Recurring Bill Line Object Definition

lookup

List all the fields and relationships for the recurring bill line object:

<lookup>
    <object>APRECURBILLENTRY</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use APRECURBILLENTRY

List Recurring Bill Lines

query

List the record number and amount for each recurring bill line:

<query>
    <object>APRECURBILLENTRY</object>
    <select>
        <field>RECORDNO</field>
        <field>AMOUNT</field>
    </select>
</query>

Parameters

Name Required Type Description
object Required string Use APRECURBILLENTRY
select Required sequence One or more field names and an optional aggregate function such as count or sum. Returning all fields is not supported.
filter Optional object Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
        <field>RECORDNO</field>
        <descending/>
</order>
options Optional object Set the caseinsensitive element to true for a case-insensitive query:
    <caseinsensitive>true</caseinsensitive>
In a multi-entity company, set the showprivate element to true to query data in private entities:
   <showprivate>true</showprivate>
pagesize Optional integer Custom page size between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

List Recurring Bill Lines (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APRECURBILLENTRY
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. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Recurring Bill Line

read

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

Parameters

Name Required Type Description
object Required string Use APRECURBILLENTRY
keys Required string Object 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.

Provide feedback