# Export bills by paypoint GET https://api-sandbox.payabli.com/api/Export/bills/{format}/{entry} Export a list of bills for an entrypoint. Use filters to limit results. Reference: https://docs.payabli.com/developers/api-reference/bill/export-bills ## OpenAPI Specification ```yaml openapi: 3.1.1 info: title: Export list of bills for an entrypoint version: endpoint_export.ExportBills paths: /Export/bills/{format}/{entry}: get: operationId: export-bills summary: Export list of bills for an entrypoint description: Export a list of bills for an entrypoint. Use filters to limit results. tags: - - subpackage_export parameters: - name: format in: path description: 'Format for the export, either XLSX or CSV. ' required: true schema: $ref: '#/components/schemas/type_export:ExportFormat1' - name: entry in: path description: >- The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry) required: true schema: type: string - name: columnsExport in: query required: false schema: type: string - name: fromRecord in: query description: >- The number of records to skip before starting to collect the result set. required: false schema: type: integer default: 0 - name: limitRecord in: query description: >- The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records. required: false schema: type: integer default: 25000 - name: parameters in: query description: >- Collection of field names, conditions, and values used to filter the query **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.** Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. For example: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20 should become: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20 See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help. List of field names accepted: - `status` (in, nin, eq, ne) - `billNumber` (ct, nct, eq, ne) - `billDate` (gt, ge, lt, le, eq, ne) - `billDueDate` (gt, ge, lt, le, eq, ne) - `vendorNumber` (ct, nct, eq, ne) - `vendorName` (ct, nct, eq, ne) - `ein` (ct, nct, eq, ne) - `paymentMethod` (ct, nct, eq, ne) - `paymentId` (ct, nct, eq, ne) - `paymentgroup` (ct, nct, eq, ne) - `totalAmount` (gt, ge, lt, le, eq, ne) - `paypointLegal` (ne, eq, ct, nct) - `paypointDba` (ne, eq, ct, nct) - `orgName` (ne, eq, ct, nct) List of comparison accepted - enclosed between parentheses: - eq or empty => equal - gt => greater than - ge => greater or equal - lt => less than - le => less or equal - ne => not equal - ct => contains - nct => not contains - in => inside array separated by "|" - nin => not inside array separated by "|" List of parameters accepted: - limitRecord : max number of records for query (default="20", "0" or negative value for all) - fromRecord : initial record in query Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.00 required: false schema: type: object additionalProperties: type: string - name: requestToken in: header required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/type_:File' '400': description: Bad request/ invalid data content: {} '401': description: Unauthorized request. content: {} '500': description: Internal API Error content: {} '503': description: Database connection error content: {} components: schemas: type_export:ExportFormat1: type: string enum: - value: csv - value: xlsx type_:File: type: object additionalProperties: description: Any type ``` ## SDK Code Examples ```python from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.export.export_bills( entry="8cfec329267", format="csv", columns_export="BatchDate:Batch_Date,PaypointName:Legal_name", from_record=251, limit_record=1000, ) ``` ```typescript import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.export.exportBills("csv", "8cfec329267", { columnsExport: "BatchDate:Batch_Date,PaypointName:Legal_name", fromRecord: 251, limitRecord: 1000 }); ``` ```go import ( context "context" option "github.com/payabli/sdk-go/option" sdkgo "github.com/payabli/sdk-go" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.Export.ExportBills( context.TODO(), "8cfec329267", sdkgo.ExportFormat1Csv, &sdkgo.ExportBillsRequest{ ColumnsExport: sdkgo.String( "BatchDate:Batch_Date,PaypointName:Legal_name", ), FromRecord: sdkgo.Int( 251, ), LimitRecord: sdkgo.Int( 1000, ), }, ) ``` ```csharp using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.Export.ExportBillsAsync( "8cfec329267", ExportFormat1.Csv, new ExportBillsRequest { ColumnsExport = "BatchDate:Batch_Date,PaypointName:Legal_name", FromRecord = 251, LimitRecord = 1000, } ); ``` ```ruby require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Export/bills/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Export/bills/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000") .header("requestToken", "") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/Export/bills/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Export/bills/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```