GetCharities

This call is to retrieve an array of Charity objects for the location.

Request Parameters

CharityIds Array of int — Depending on the CharityId(-s) passed in request the response will return the details of that(those) charity(-s)

Response Parameters

AutomaticallyApply bool — True if automatically apply the charity to all orders that qualify, False if not
Days byte? — Limits the day(s) of the week on which the charity can be assigned:
- 0 = None
- 1 = Sunday
- 2 = Monday
- 4 = Tuesday
- 8 = Wednesday
- 16 = Thursday
- 32 = Friday
- 64 = Saturday
If multiple days are selected, binary addition is used in determining this value.
EndDate DateTime? — Limits the end date on which the charity can be applied
EndTime TimeSpan? — Limits the end time of day during which the charity can be assigned
EnforceDateRange bool — True if limits the date(s) on which the charity can be applied, False if not
EnforceDays bool — True if limits the day(s) of the week on which the charity can be assigned, False if not
EnforceMaximumPerOrder bool — True if limits the number of times the charity can be assigned to an order, False if not
EnforceTimeRange bool — True if limits the time of day during which the charity can be assigned, False if not
Id int — Unique Id of this Charity
IsActive bool — True if charity can be assigned to orders, False if not
Items Array of CharityItem — These items will have their sales counted towards the charity
CharityItem Properties
- ItemId int — Maps to the Id of the Item that contributes sales toward this Charity
MaximumPerOrder int? — Number of times the charity can be assigned to an order
Name string — Name of the charity
NonRevenueItemId int — ItemId selected for the roundup charity
Percent decimal — Charity amount to be applied as a percent of the order sub-total
RoundUp bool — True if activated the 'round up for charity' feature, False if not
StartDate DateTime? — Limits the start date on which the charity can be applied
StartTime TimeSpan? — Limits the start time of day during which the charity can be assigned

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetCharities request with optional CharityIds.

Responses

text/xml; charset=utf-8

post/GetCharities

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetCharities' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetCharities"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetCharities>
        <v2:request/>
      </v2:GetCharities>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetCharitiesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetCharitiesResult>
        <Collection>
          <Charity>
            <Id>1</Id>
            <Name>Local Food Bank</Name>
            <AutomaticallyApply>false</AutomaticallyApply>
            <Days>62</Days>
            <EndDate>2025-12-31T00:00:00</EndDate>
            <EndTime>PT22H0M0S</EndTime>
            <EnforceDateRange>true</EnforceDateRange>
            <EnforceDays>true</EnforceDays>
            <EnforceMaximumPerOrder>true</EnforceMaximumPerOrder>
            <EnforceTimeRange>true</EnforceTimeRange>
            <IsActive>true</IsActive>
            <Items>
              <CharityItem>
                <ItemId>1001</ItemId>
              </CharityItem>
              <CharityItem>
                <ItemId>1002</ItemId>
              </CharityItem>
            </Items>
            <MaximumPerOrder>1</MaximumPerOrder>
            <NonRevenueItemId>9001</NonRevenueItemId>
            <Percent>5.00</Percent>
            <RoundUp>true</RoundUp>
            <StartDate>2025-01-01T00:00:00</StartDate>
            <StartTime>PT9H0M0S</StartTime>
          </Charity>
        </Collection>
        <ValidationMessages/>
      </GetCharitiesResult>
    </GetCharitiesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Charity objects.