About RecurringBill
A Recurring Bill represents an identical Bill created periodically for a Vendor. This is a template used to automatically generate bills into the future. If a bill requires review for approval, a Bill Approver is associated through Approval APIs.
Note: Recurring Bills automatically remember and assign Approval Users based on prior Bills for a Vendor. Once the approval process is applied, it is assigned to new bills when they are created. If no prior bills for a vendor exist, Approval User(s) are not set.
When a recurring bill is edited/deleted, it only affects future bills. When a bill is generated, the Invoice number is the same as the Due Date. If more than one Bill is generated with the same Due Date for a Vendor, the Invoice number is assigned as follows: MM-DD-YYYY (1), MM-DD-YYYY (2), MM-DD-YYYY (3)
Note: The nested RecurringBillLineItem array includes more details on the goods or services purchased from the vendor.
Create
Request
<API_URL_EndPoint>/Crud/Create/RecurringBill.json
data={
"obj" : {
"entity" : "RecurringBill",
"isActive" : "1",
"vendorId" : "00901FABIIZFVKV2pzsy",
"timePeriod" : "2",
"frequencyPerTimePeriod" : 1,
"nextDueDate" : "2017-01-05",
"endDate" : "2017-12-05",
"daysInAdvance" : 1,
"description" : "Services and deliveries.",
"recurringBillLineItems" : [ {
"entity" : "RecurringBillLineItem",
"amount" : 350.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : ""
}, {
"entity" : "RecurringBillLineItem",
"amount" : 200.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : ""
} ]
}
}
Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "RecurringBill",
"id" : "btp01OFHPATIRQGG1jyl",
"isActive" : "1",
"vendorId" : "00901FABIIZFVKV2pzsy",
"timePeriod" : "2",
"frequencyPerTimePeriod" : 1,
"nextDueDate" : "2017-01-05",
"endDate" : "2017-12-05",
"daysInAdvance" : 1,
"description" : "Services and deliveries.",
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000",
"recurringBillLineItems" : [ {
"entity" : "RecurringBillLineItem",
"id" : "tli01AELMNXQRHEU1pio",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 350.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000"
}, {
"entity" : "RecurringBillLineItem",
"id" : "tli01FETFFZLEYIL1pip",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 200.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:49.000+0000",
"updatedTime" : "2016-12-13T20:22:49.000+0000"
} ]
}
}Read
Request
<API_URL_EndPoint>/Crud/Read/RecurringBill.json
data={
"id" : "btp01OFHPATIRQGG1jyl"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "RecurringBill",
"id" : "btp01OFHPATIRQGG1jyl",
"isActive" : "1",
"vendorId" : "00901FABIIZFVKV2pzsy",
"timePeriod" : "2",
"frequencyPerTimePeriod" : 1,
"nextDueDate" : "2017-01-05",
"endDate" : "2017-12-05",
"daysInAdvance" : 1,
"description" : "Services and deliveries.",
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000",
"recurringBillLineItems" : [ {
"entity" : "RecurringBillLineItem",
"id" : "tli01AELMNXQRHEU1pio",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 350.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000"
}, {
"entity" : "RecurringBillLineItem",
"id" : "tli01FETFFZLEYIL1pip",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 200.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:49.000+0000",
"updatedTime" : "2016-12-13T20:22:49.000+0000"
} ]
}
}Update
The details of the specified Recurring Bill are overwritten with the details you pass at the time of updating it. For example, if you want to update the details of a specific Recurring Bill line item, you need to enter all the details of the Recurring Bill and the other RecurringbillLineItems.
Request
<API_URL_EndPoint>/Crud/Update/RecurringBill.json
data={
"obj" : {
"entity" : "RecurringBill",
"id" : "btp01OFHPATIRQGG1jyl",
"isActive" : "1",
"vendorId" : "00901FABIIZFVKV2pzsy",
"timePeriod" : "2",
"frequencyPerTimePeriod" : 1,
"nextDueDate" : "2017-01-05",
"endDate" : "2017-12-05",
"daysInAdvance" : 1,
"description" : "Services and deliveries.",
"recurringBillLineItems" : [ {
"entity" : "RecurringBillLineItem",
"id" : "tli01AELMNXQRHEU1pio",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 350.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : "Services"
}, {
"entity" : "RecurringBillLineItem",
"id" : "tli01FETFFZLEYIL1pip",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 200.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : "Deliveries"
} ]
}
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "RecurringBill",
"id" : "btp01OFHPATIRQGG1jyl",
"isActive" : "1",
"vendorId" : "00901FABIIZFVKV2pzsy",
"timePeriod" : "2",
"frequencyPerTimePeriod" : 1,
"nextDueDate" : "2017-01-05",
"endDate" : "2017-12-05",
"daysInAdvance" : 1,
"description" : "Services and deliveries.",
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:29:12.000+0000",
"recurringBillLineItems" : [ {
"entity" : "RecurringBillLineItem",
"id" : "tli01AELMNXQRHEU1pio",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 350.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : "Services",
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:29:12.000+0000"
}, {
"entity" : "RecurringBillLineItem",
"id" : "tli01FETFFZLEYIL1pip",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 200.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : "Deliveries",
"createdTime" : "2016-12-13T20:22:49.000+0000",
"updatedTime" : "2016-12-13T20:29:12.000+0000"
} ]
}
}Delete
Once the Recurring Bill is deleted, it is marked as inactive ["isActive" : "2"].
Request
<API_URL_EndPoint>/Crud/Delete/RecurringBill.json
data={
"id" : "btp01OFHPATIRQGG1jyl"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "RecurringBill",
"id" : "btp01OFHPATIRQGG1jyl",
"isActive" : "2",
"vendorId" : "00901FABIIZFVKV2pzsy",
"timePeriod" : "2",
"frequencyPerTimePeriod" : 1,
"nextDueDate" : "2017-01-05",
"endDate" : "2017-12-05",
"daysInAdvance" : 1,
"description" : "Services and deliveries.",
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000",
"recurringBillLineItems" : [ {
"entity" : "RecurringBillLineItem",
"id" : "tli01AELMNXQRHEU1pio",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 350.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000"
}, {
"entity" : "RecurringBillLineItem",
"id" : "tli01FETFFZLEYIL1pip",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 200.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:49.000+0000",
"updatedTime" : "2016-12-13T20:22:49.000+0000"
} ]
}
}Undelete
Once the Recurring Bill is undeleted, it is marked as active ["isActive" : "1"].
Request
<API_URL_EndPoint>/Crud/Undelete/RecurringBill.json
data={
"id" : "btp01OFHPATIRQGG1jyl"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "RecurringBill",
"id" : "btp01OFHPATIRQGG1jyl",
"isActive" : "1",
"vendorId" : "00901FABIIZFVKV2pzsy",
"timePeriod" : "2",
"frequencyPerTimePeriod" : 1,
"nextDueDate" : "2017-01-05",
"endDate" : "2017-12-05",
"daysInAdvance" : 1,
"description" : "Services and deliveries.",
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000",
"recurringBillLineItems" : [ {
"entity" : "RecurringBillLineItem",
"id" : "tli01AELMNXQRHEU1pio",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 350.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:48.000+0000",
"updatedTime" : "2016-12-13T20:22:48.000+0000"
}, {
"entity" : "RecurringBillLineItem",
"id" : "tli01FETFFZLEYIL1pip",
"recurringBillId" : "btp01OFHPATIRQGG1jyl",
"amount" : 200.00,
"chartOfAccountId" : "0ca01BLAYWXENURGdgne",
"departmentId" : "0de01BQOIPAFNQKUazch",
"locationId" : "loc01ZCLEVLXDQRB9z1o",
"description" : null,
"createdTime" : "2016-12-13T20:22:49.000+0000",
"updatedTime" : "2016-12-13T20:22:49.000+0000"
} ]
}
}Resources
Parameters