Home

ARInvoice

POST api/Payment/{systemID}/PaymentMethods/ARInvoice/PostPayments?chargeAccountID={chargeAccountID}

Post payments to invoice.

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
chargeAccountID 
Unique ID of the charge account. [*Required]

Define this parameter in the request URI.
invoiceItem 
InvoiceItemData object
            [*Amount AND PostDate required in PostPayments]
            RxNumber - Rx Number of prescription to post towards, [*Ignored in PostPayments]
            Description - Description of posted item, [*Optional]
            QtyDispensed - If post is a charged prescription, quantity of prescription [*Ignored in PostPayments]
            Amount - Amount of payment, [*Required]
            DiscountAmount - Amount of discount, [*Ignored in PostPayments]
            TaxAmount - Amount of tax, [*Ignored in PostPayments]
            Department - Department identifier, [*Ignored in PostPayments]
            MedDeduct - Deductible?, [*Yes/No (Y/N), Ignored in PostPayments]
            LegendIndicator - Legend?, [*Yes/No (Y/N), Ignored in PostPayments]
            InvoiceNumber - # of invoice to post to, [*Optional - Defaults to current invoice]
            PostDate - Date of post, [*Required - Format: MM/DD/YY]
            MiscDate - Miscellaneous date. [*Optional - Format: MM/DD/YY]

Define this parameter in the request body.
    

Response Codes

    
  • OK (200)
  • NotFound (404)
  • InternalServerError (500)
  • BadRequest (400)
    •     

Request body formats

application/json, text/json

Sample: 
{
  "RxNumber": "sample string 1",
  "Description": "sample string 2",
  "QtyDispensed": "sample string 3",
  "Amount": "sample string 4",
  "DiscountAmount": "sample string 5",
  "TaxAmount": "sample string 6",
  "Department": "sample string 7",
  "MedDeduct": "sample string 8",
  "LegendIndicator": "sample string 9",
  "InvoiceNumber": "sample string 10",
  "PatientName": "sample string 11",
  "PostDate": "sample string 12",
  "MiscDate": "sample string 13"
}

text/javascript

Sample: 
{"RxNumber":"sample string 1","Description":"sample string 2","QtyDispensed":"sample string 3","Amount":"sample string 4","DiscountAmount":"sample string 5","TaxAmount":"sample string 6","Department":"sample string 7","MedDeduct":"sample string 8","LegendIndicator":"sample string 9","InvoiceNumber":"sample string 10","PatientName":"sample string 11","PostDate":"sample string 12","MiscDate":"sample string 13"}

application/xml, text/xml

Sample: 
<InvoiceItemData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFLibrary.Common.Data">
  <Amount>sample string 4</Amount>
  <Department>sample string 7</Department>
  <Description>sample string 2</Description>
  <DiscountAmount>sample string 5</DiscountAmount>
  <InvoiceNumber>sample string 10</InvoiceNumber>
  <LegendIndicator>sample string 9</LegendIndicator>
  <MedDeduct>sample string 8</MedDeduct>
  <MiscDate>sample string 13</MiscDate>
  <PatientName>sample string 11</PatientName>
  <PostDate>sample string 12</PostDate>
  <QtyDispensed>sample string 3</QtyDispensed>
  <RxNumber>sample string 1</RxNumber>
  <TaxAmount>sample string 6</TaxAmount>
</InvoiceItemData>