POST Process Statements

{ "tab" "examples", "url" "https //gfp api acdev io/api/v1/pending invoices/process", "name" "process statements", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "ids", "type" "array", "children" \[ { "kind" "required", "name" "statementdate", "type" "string", "children" \[], "description" "date object represented as 2023 06 22" }, { "kind" "required", "name" "rownum", "type" "integer", "description" "index of the upload object being uploaded" }, { "kind" "optional", "name" "patientid", "type" "string", "description" "pms id of patient" }, { "kind" "optional", "name" "providerid", "type" "string", "description" "pms id of patient's provider" }, { "kind" "optional", "name" "amountdue", "type" "number", "description" "amount of the statement represented in cents e g 600 for $6" }, { "kind" "optional", "name" "firstname", "type" "string", "description" "patient's first name" }, { "kind" "optional", "name" "lastname", "type" "string", "description" "patient's last name" }, { "kind" "optional", "name" "email", "type" "string", "description" "patient's email must be provided if patient is to get statement via email" }, { "kind" "optional", "name" "smsphonenumber", "type" "string", "description" "patient's phone number must be provided if patient is to get statement texted format is +15555555555" }, { "kind" "optional", "name" "addressline1", "type" "string", "description" "address line 1" }, { "kind" "optional", "name" "addressline2", "type" "string", "description" "address line2" }, { "kind" "optional", "name" "addresscity", "type" "string", "description" "address city" }, { "kind" "optional", "name" "addressstate", "type" "string", "description" "address state" }, { "kind" "optional", "name" "addresszip", "type" "string", "description" "address zip" }, { "kind" "optional", "name" "patientnote", "type" "string", "description" "custom note to be provided to patient on their invoice" }, { "kind" "optional", "name" "externallocationid", "type" "string", "description" "if uploading a file for multiple locations at once, must specify your identifier for this location this is configured via the store admin configurations panel" }, { "kind" "optional", "name" "lineitems", "type" "object", "children" \[ { "kind" "optional", "name" "date", "type" "string", "description" "date of upload formatted as yyyy mm dd" }, { "kind" "optional", "name" "dateofservice", "type" "string", "description" "date of procedure service formatted as yyyy mm dd" }, { "kind" "optional", "name" "sku", "type" "string", "description" "procedure sku" }, { "kind" "optional", "name" "charges", "type" "integer", "description" "charges for this line item, represented in cents" }, { "kind" "optional", "name" "credit", "type" "integer", "description" "credit for this line item, represented in cents this represents any negative amount applied to procedure (e g insurance payment, pre payment, discount, etc)\n" }, { "kind" "optional", "name" "balance", "type" "integer", "description" "overall amount for this line item" }, { "kind" "optional", "name" "patientfirstname", "type" "string", "description" "if billing to a guarantor for a dependent's procedure, include that dependent's name here" }, { "kind" "optional", "name" "patientlastname", "type" "string", "description" "if billing to a guarantor for a dependent's procedure, include that dependent's name here" } ], "description" "array of billable line items these can be credits as well (e g $50 already paid)" } ], "description" "array of statement ids to process this id is sent back as `id` in the response when first uploading file or when calling get statements \n\nrequired if filter is not used " }, { "name" "filter", "kind" "optional", "type" "string", "description" "a rsql status status=in=(\\"pending\\") to use instead of the array of ids if ids are passed the filter will be ignored \n\nrequired if ids is not used ", "children" \[] } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "c0f7bjpcqhajikyibqef0", "code" "success", "language" "200", "customlabel" "" } ], "selectedlanguageid" "c0f7bjpcqhajikyibqef0" }, "examples" { "languages" \[ { "id" "tsjh4baruelrazdnupv8e", "code" "curl x post \\\\\n url 'https //gfp api acdev io/api/v1/pending invoices/process' \\\\\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}' \\\\\n data raw '\n{\n \\"ids\\" \[\\"01h3jk407g9sbrgsj1zrw7v93t\\"]\n}'", "language" "json", "customlabel" "ids" }, { "id" "c2ncs9j hqbzpramj2vob", "language" "json", "code" "curl x post \\\\\n url 'https //gfp api acdev io/api/v1/pending invoices/process' \\\\\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}' \\\\\n data raw '\n{\n \\"filter\\" \\"status=in=(\\\\\\"pending\\\\\\")\\"\n}'", "customlabel" "filter" } ], "selectedlanguageid" "c2ncs9j hqbzpramj2vob" }, "description" "the backend code requires your store id, private key, and a means to identify the desired statements this can be achieved through specific statement ids or a defined filter in case both are provided, statement ids will be prioritized ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }