Implementing Pagination for Bill API Source Connector in Airbyte's CDK

Slack Knowledge Base Q&A Connector Questions
, , , ,
1

Summary

The user is seeking help on how to increment the ‘start’ field by 999 for pagination in the Bill API source connector using Airbyte’s low-code CDK. They are unsure how to configure the YAML file to alter the nested ‘start’ field for implementing the offset.


Question

Hi,
I’m building a source connector for the Bill API using Airbyte’s low-code CDK.

I’m trying to implement pagination. This is what the payload of the request to the API looks like:

    "data": "{"start":0,"max":999}",
    "devKey": "xx",
    "sessionId": "xx"
}```
The "start" field represents the index of the first record that should be returned, and the "max" field is the maximum number of records that can be returned in the response. The highest value for this is 999.

I need to implement pagination, and I need the "start" field to be incremented by 999 to request a new page of records for every subsequent request until there are no more records left to be returned by the API.

*MY ISSUE:* How exactly can I increment the "start" field by 999, since it is nested within the payload? On top of this, the payload is sent to the API in form encoded format, and I'm not sure how to configure the YAML file in order to alter the nested "start" field for implementing the offset. Please help.
Here's the link to the API docs and the endpoint in question:
<https://developer.bill.com/reference/ap-vendormgmt-listvendor>


*BILL API documentation*
*<https://developer.bill.com/reference/ap-vendormgmt-listvendor|List vendors>*
List vendor objects. See Search operations with lists to learn about pagination, sorting, and filtering. Vendor address details are required for paying the vendor by check or for inviting the vendor to join the BILL network. Keep this information current at all times. nameOnCheck address1 addressCit...

<br>

---

This topic has been created from a Slack thread to give it more visibility.
It will be on Read-Only mode here. [Click here](https://airbytehq.slack.com/archives/C021JANJ6TY/p1724701338768929) if you want 
to access the original thread.

[Join the conversation on Slack](https://slack.airbyte.com)

<sub>
["bill-api", "source-connector", "pagination", "airbyte-cdk", "yaml-configuration"]
</sub>