POST Statements

important notes patientid icorepay internal ulid use to directly link to an internal patient externalpmspatientid this is the pms's patient identifier externalpatientid this is your identifier for the patient (can be the same as the pms's patient identifer) { "tab" "examples", "url" "https //gfp api acdev io/api/v1/pending invoices/", "name" "upload statements", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "filename", "type" "string", "children" \[], "description" "filename of the statement being processed only 1 filename can be uploaded per store within a 24 hour period to prevent accidental simultaneous uploads" }, { "kind" "required", "name" "pendinginvoiceuploads", "type" "object", "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" "icorepay internal ulid use to directly link to an internal 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)" }, { "name" "posorderid", "kind" "optional", "type" "string", "description" "point of sale reference id values of length greater than 200 characters will be truncated when saved " }, { "name" "externalpatientid", "kind" "required", "type" "string", "description" "an identifier from the external source can match externalpmspatientid " }, { "name" "externalpmspatientid", "kind" "required", "type" "string", "description" "identifier provided for patient from the patient management system deprecated patientid field will be mapped here " } ], "description" "array of pending invoice upload objcts" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "c0f7bjpcqhajikyibqef0", "code" "{\n \\"savedpaymentid\\" \\"01gqsvmzh59xssxfxknbznw6py\\"\n}\n", "language" "200", "customlabel" "" } ], "selectedlanguageid" "c0f7bjpcqhajikyibqef0" }, "examples" { "languages" \[ { "id" "tsjh4baruelrazdnupv8e", "code" "curl x post \\\\\n url 'https //gfp api acdev io/api/v1/pending invoices' \\\\\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 \\"filename\\" \\"test upload xlsx\\",\n \\"pendinginvoiceuploads\\" \[\n {\n \\"statementdate\\" \\"2022 11 08\\",\n \\"patientid\\" \\"2006 1000009\\",\n \\"firstname\\" \\"john\\",\n \\"lastname\\" \\"snow\\",\n \\"email\\" \\"the white wolf\@winterfell com\\",\n \\"smsphonenumber\\" \\"+15556873509\\",\n \\"addressline1\\" \\"1 castle\\",\n \\"addresscity\\" \\"winterfell\\",\n \\"addressstate\\" \\"ga\\",\n \\"addresszip\\" \\"30030\\",\n \\"amountdue\\" 15780,\n \\"patientnote\\" \\"lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum \\",\n \\"posorderid\\" \\"deadbeef dead beef dead beefdeadbeef\\",\n \\"lineitems\\" \[\n {\n \\"date\\" \\"2022 11 08\\",\n \\"dateofservice\\" \\"2022 04 11\\",\n \\"sku\\" \\"d1110\\",\n \\"description\\" \\"prophylaxis adult\\",\n \\"charges\\" 13900,\n \\"credit\\" 13700,\n \\"balance\\" 200,\n \\"patientfirstname\\" \\"daenerys\\",\n \\"patientlastname\\" \\"targaryen\\"\n },\n {\n \\"date\\" \\"2022 11 08\\",\n \\"dateofservice\\" \\"2022 04 11\\",\n \\"sku\\" \\"d0274\\",\n \\"description\\" \\"bitewings four radiographic images\\",\n \\"charges\\" 9800,\n \\"credit\\" 9400,\n \\"balance\\" 400,\n \\"patientfirstname\\" \\"daenerys\\",\n \\"patientlastname\\" \\"targaryen\\"\n },\n {\n \\"date\\" \\"2022 11 08\\",\n \\"dateofservice\\" \\"2021 10 07\\",\n \\"description\\" \\"insurance adjustment\\",\n \\"charges\\" 2100,\n \\"balance\\" 2100,\n \\"patientfirstname\\" \\"daenerys\\",\n \\"patientlastname\\" \\"targaryen\\"\n },\n {\n \\"date\\" \\"2022 11 08\\",\n \\"dateofservice\\" \\"2021 10 09\\",\n \\"sku\\" \\"d2392\\",\n \\"description\\" \\"resin based composite two surfaces, posterior\\",\n \\"charges\\" 35100,\n \\"credit\\" 32060,\n \\"balance\\" 3040,\n \\"patientfirstname\\" \\"daenerys\\",\n \\"patientlastname\\" \\"targaryen\\"\n },\n {\n \\"date\\" \\"2022 11 08\\",\n \\"dateofservice\\" \\"2022 04 11\\",\n \\"sku\\" \\"d2392\\",\n \\"description\\" \\"resin based composite two surfaces, posterior\\",\n \\"charges\\" 35100,\n \\"credit\\" 32060,\n \\"balance\\" 3040,\n \\"patientfirstname\\" \\"daenerys\\",\n \\"patientlastname\\" \\"targaryen\\"\n },\n {\n \\"date\\" \\"2022 11 08\\",\n \\"dateofservice\\" \\"2021 10 07\\",\n \\"sku\\" \\"d1208\\",\n \\"description\\" \\"topical application of fluoride – excluding varnish\\",\n \\"charges\\" 5900,\n \\"credit\\" 2400,\n \\"balance\\" 3500,\n \\"patientfirstname\\" \\"daenerys\\",\n \\"patientlastname\\" \\"targaryen\\"\n },\n {\n \\"date\\" \\"2022 11 08\\",\n \\"dateofservice\\" \\"2022 04 11\\",\n \\"sku\\" \\"d1208\\",\n \\"description\\" \\"topical application of fluoride – excluding varnish\\",\n \\"charges\\" 5900,\n \\"credit\\" 2400,\n \\"balance\\" 3500,\n \\"patientfirstname\\" \\"daenerys\\",\n \\"patientlastname\\" \\"targaryen\\"\n }\n ]\n }\n ]\n}'", "language" "json", "customlabel" "" } ], "selectedlanguageid" "tsjh4baruelrazdnupv8e" }, "description" "from your backend code, upload statements with your store id and private key ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }