GET Statements

to get pending statement information, call get on the pending statement endpoint with your private key from your server and a few request parameters we use pagination in the backend, with a maximum limit of 100 the search query param uses rsql with the following keys note to use and or or filters, delimit your search parameters using ";" for logical and, and "," for logical or operator definition example == equals status==pending != not equals status!=failed =gt= greater than amountdue=gt=0 =ge= greater than or equals amountdue=ge=0 =lt= less than amountdue=lt=100000 =le= less than or equals amountdue=le=100000 =in= in status=in=(pending,inprogress) =out= not in status=out=(failed) { "tab" "examples", "url" "https //gfp api acdev io/api/v1/pending invoices/search", "name" "get pending invoices", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "limit", "type" "string", "children" \[], "description" "number of items per page to be returned" }, { "kind" "required", "name" "offset", "type" "string", "children" \[], "description" "page number e g 0 for first 100 items if limit is 100, 1 for next 100 items, etc" }, { "kind" "required", "name" "sort", "type" "string", "children" \[], "description" "sort parameters \ne g sort= updateddt" }, { "kind" "required", "name" "filter", "type" "string", "children" \[], "description" "search parmeters use the rsql query with the parameters above\ne g filter=status=in=(pending,inprogress);amountdue=ge=0" } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "pminq8c m98c slp9 w4z", "code" "{\n \\"entities\\" \[\n {\n \\"id\\" \\"01h3jk407g9sbrgsj1zrw7v93t\\",\n \\"storeid\\" \\"01gdg5bza29r3szmz63y2gfenv\\",\n \\"amountdue\\" 15780,\n \\"plannedexecutiondt\\" \\"2023 06 22t18 20 39 476145\\",\n \\"email\\" \\"the white wolf\@winterfell com\\",\n \\"smsphonenumber\\" \\"+15556873509\\",\n \\"firstname\\" \\"john\\",\n \\"lastname\\" \\"snow\\",\n \\"internalpatientid\\" \\"01h3jk403f9mps8h79cthr1rqc\\",\n \\"externalpatientid\\" \\"2006 1000009\\",\n \\"filename\\" \\"test upload xlsx\\",\n \\"createdby\\" \\"admin\@localhost com\\",\n \\"createddt\\" \\"2023 06 22t18 20 39 536412\\",\n \\"updateddt\\" \\"2023 06 22t18 20 39 536422\\",\n \\"sendemail\\" true,\n \\"sendtext\\" true,\n \\"sendpaper\\" false,\n \\"abletosendemail\\" true,\n \\"abletosendtext\\" true,\n \\"abletosendpaper\\" true,\n \\"warnings\\" \[],\n \\"errors\\" \[],\n \\"status\\" \\"pending\\"\n }\n ],\n \\"currentpage\\" 0,\n \\"totalitems\\" 1,\n \\"totalpages\\" 1\n }", "language" "200", "customlabel" "" }, { "id" "lmm 9bhz550f6vsplnskh", "code" "{\n \\"suberrors\\" \[],\n \\"status\\" \\"bad request\\",\n \\"message\\" \\"could not find store for orders id 01fywbxkkh8dx8mfbz37vmyva1\\"\n}", "language" "400", "customlabel" "" } ], "selectedlanguageid" "pminq8c m98c slp9 w4z" }, "examples" { "languages" \[ { "id" "i5pmfxvj3c4yyx32197il", "code" "curl request get \\\\\n url 'https //test api featherpay io/api/v1/pending invoices/search?filter=status%3din%3d(pending)\&sort= updateddt\&limit=10\&offset=0' \\\\\n header 'content type application/json;charset=utf 8' \\\\\n header 'accept application/json' \\\\\n header 'x api key {secret api key}' \\\\\n header 'x store id {store ulid}'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "i5pmfxvj3c4yyx32197il" }, "description" "get pending invoices by query", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } response json { "currentpage" 0 //current page of pagination should equal offset "totalitem" 110 //total items that match the query "totalpages" 10 // will be the total pages needed to paginate to get all items "entities" \[] //array of the entities to be returned }