GET api/Receipt/{id}?portalId={portalId}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required
portalId		string	None.

Body Parameters

None.

Response Information

Resource Description

Receipt

Name	Type	Additional information
LateBoundStatesAtCheckout	boolean	None.
AddressValidationUrl	string	None.
UseInternational	boolean	None.
InternationalAutocompleteUrl	string	None.
AutoCompleteUrl	string	None.
AddressValidationKey	string	None.
UseAddressValidation	boolean	None.
UseAddressAutoComplete	boolean	None.
BillToStates	Collection of StateProvince	None.
BillToCountries	Collection of Country	None.
SelectedPaymentOption	string	None.
PaymentTypes	Collection of Option	None.
PaymentOptions	Collection of PaymentOption	None.
OptionalAddOnCategory	globally unique identifier	None.
BillToStreet1	string	None.
BillToStreet2	string	None.
BillToCity	string	None.
BillToState	string	None.
BillToZip	string	None.
BillToCountry	string	None.
Custom1	string	None.
Custom2	string	None.
Custom3	string	None.
Custom4	string	None.
Custom5	string	None.
Custom6	string	None.
Name	string	None.
Description	string	None.
InvoiceHtml	string	None.
HasCustomInvoiceHtml	boolean	None.
BillTo	string	None.
ShipTo	string	None.
CustomerId	string	None.
Id	string	None.
InvoiceId	string	None.
Email	string	None.
DatePaid	date	None.
DueDate	date	None.
InvoiceDate	date	None.
InvoiceNumber	string	None.
InvoiceTotal	decimal number	None.
Payments	Collection of ReceiptInvoicePayment	None.
Details	Collection of ReceiptInvoiceDetail	None.
Credits	decimal number	None.
Discounts	decimal number	None.
BalanceDue	decimal number	None.
PaymentAmount	decimal number	None.
ReceiptType	integer	None.
PaidThroughDate	date	None.
StatusReason	integer	None.
NameOnCard	string	None.
CardNumber	string	None.
ExpirationDate	string	None.
CSV	string	None.
PaymentType	integer	None.
BankAccountTypes	Collection of Option	None.
DefaultAccountingCompany	AccountingCompanyResult	None.
PayFieldsApiKey	string	None.
PayFieldsEnvironment	string	None.
IsDuesInvoice	boolean	None.
IsPPLInvoice	boolean	None.
PrimaryMembershipId	globally unique identifier	None.
IsAutoPay	boolean	None.
PPL	string	None.
PPD	string	None.
PacHtml	string	None.
SaveAsWalletText	string	None.
HasRenewalWallet	boolean	None.
EntityType	string	None.

Response Formats

application/json, text/json

Sample:

{
  "LateBoundStatesAtCheckout": true,
  "AddressValidationUrl": "sample string 2",
  "UseInternational": true,
  "InternationalAutocompleteUrl": "sample string 4",
  "AutoCompleteUrl": "sample string 5",
  "AddressValidationKey": "sample string 6",
  "UseAddressValidation": true,
  "UseAddressAutoComplete": true,
  "BillToStates": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Country": "sample string 4"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Code": "sample string 3",
      "Country": "sample string 4"
    }
  ],
  "BillToCountries": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Code": "sample string 3",
      "RequireState": true,
      "ShowState": true,
      "ShowStateAsText": true,
      "RequireCity": true,
      "ShowCity": true,
      "RequireZip": true,
      "ShowZip": true
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Code": "sample string 3",
      "RequireState": true,
      "ShowState": true,
      "ShowStateAsText": true,
      "RequireCity": true,
      "ShowCity": true,
      "RequireZip": true,
      "ShowZip": true
    }
  ],
  "SelectedPaymentOption": "sample string 9",
  "PaymentTypes": [
    {
      "Value": "sample string 1",
      "Code": "sample string 2",
      "CountryId": "sample string 3",
      "Text": "sample string 4",
      "Selected": true,
      "RequireState": true,
      "ShowState": true,
      "ShowStateAsText": true,
      "RequireCity": true,
      "ShowCity": true,
      "RequireZip": true,
      "ShowZip": true
    },
    {
      "Value": "sample string 1",
      "Code": "sample string 2",
      "CountryId": "sample string 3",
      "Text": "sample string 4",
      "Selected": true,
      "RequireState": true,
      "ShowState": true,
      "ShowStateAsText": true,
      "RequireCity": true,
      "ShowCity": true,
      "RequireZip": true,
      "ShowZip": true
    }
  ],
  "PaymentOptions": [
    {
      "Id": "sample string 1",
      "Label": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Label": "sample string 2"
    }
  ],
  "OptionalAddOnCategory": "6083d6db-3082-4d2b-a77a-c46c5bb3491b",
  "BillToStreet1": "sample string 11",
  "BillToStreet2": "sample string 12",
  "BillToCity": "sample string 13",
  "BillToState": "sample string 14",
  "BillToZip": "sample string 15",
  "BillToCountry": "sample string 16",
  "Custom1": "sample string 17",
  "Custom2": "sample string 18",
  "Custom3": "sample string 19",
  "Custom4": "sample string 20",
  "Custom5": "sample string 21",
  "Custom6": "sample string 22",
  "Name": "sample string 23",
  "Description": "sample string 24",
  "InvoiceHtml": "sample string 25",
  "HasCustomInvoiceHtml": true,
  "BillTo": "sample string 27",
  "ShipTo": "sample string 28",
  "CustomerId": "sample string 29",
  "Id": "sample string 30",
  "InvoiceId": "sample string 31",
  "Email": "sample string 32",
  "DatePaid": "2025-12-05T21:39:44.9864217-06:00",
  "DueDate": "2025-12-05T21:39:44.9864217-06:00",
  "InvoiceDate": "2025-12-05T21:39:44.9864217-06:00",
  "InvoiceNumber": "sample string 33",
  "InvoiceTotal": 1.0,
  "Payments": null,
  "Details": null,
  "Credits": 34.0,
  "Discounts": 35.0,
  "BalanceDue": 36.0,
  "PaymentAmount": 37.0,
  "ReceiptType": 38,
  "PaidThroughDate": "2025-12-05T21:39:44.9864217-06:00",
  "StatusReason": 39,
  "NameOnCard": "sample string 40",
  "CardNumber": "sample string 41",
  "ExpirationDate": "sample string 42",
  "CSV": "sample string 43",
  "PaymentType": 44,
  "BankAccountTypes": [
    {
      "Value": "sample string 1",
      "Code": "sample string 2",
      "CountryId": "sample string 3",
      "Text": "sample string 4",
      "Selected": true,
      "RequireState": true,
      "ShowState": true,
      "ShowStateAsText": true,
      "RequireCity": true,
      "ShowCity": true,
      "RequireZip": true,
      "ShowZip": true
    },
    {
      "Value": "sample string 1",
      "Code": "sample string 2",
      "CountryId": "sample string 3",
      "Text": "sample string 4",
      "Selected": true,
      "RequireState": true,
      "ShowState": true,
      "ShowStateAsText": true,
      "RequireCity": true,
      "ShowCity": true,
      "RequireZip": true,
      "ShowZip": true
    }
  ],
  "DefaultAccountingCompany": {
    "AccountCompaniesName": "sample string 1",
    "PayFieldsApiKey": "sample string 2",
    "TestMode": true,
    "PaymentAuthorizationMethod": "sample string 3"
  },
  "PayFieldsApiKey": "sample string 45",
  "PayFieldsEnvironment": "sample string 46",
  "IsDuesInvoice": true,
  "IsPPLInvoice": true,
  "PrimaryMembershipId": "3275a36b-ebc5-458f-85b8-622618465a7e",
  "IsAutoPay": true,
  "PPL": "sample string 50",
  "PPD": "sample string 51",
  "PacHtml": "sample string 52",
  "SaveAsWalletText": "sample string 53",
  "HasRenewalWallet": true,
  "EntityType": "sample string 55"
}

application/xml, text/xml

Sample:

<Receipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AltaiStandard.Web.ClientIntegrationService.Models">
  <AddressValidationKey>sample string 6</AddressValidationKey>
  <AddressValidationUrl>sample string 2</AddressValidationUrl>
  <AutoCompleteUrl>sample string 5</AutoCompleteUrl>
  <BalanceDue>36</BalanceDue>
  <BankAccountTypes>
    <Option>
      <Code>sample string 2</Code>
      <CountryId>sample string 3</CountryId>
      <RequireCity>true</RequireCity>
      <RequireState>true</RequireState>
      <RequireZip>true</RequireZip>
      <Selected>true</Selected>
      <ShowCity>true</ShowCity>
      <ShowState>true</ShowState>
      <ShowStateAsText>true</ShowStateAsText>
      <ShowZip>true</ShowZip>
      <Text>sample string 4</Text>
      <Value>sample string 1</Value>
    </Option>
    <Option>
      <Code>sample string 2</Code>
      <CountryId>sample string 3</CountryId>
      <RequireCity>true</RequireCity>
      <RequireState>true</RequireState>
      <RequireZip>true</RequireZip>
      <Selected>true</Selected>
      <ShowCity>true</ShowCity>
      <ShowState>true</ShowState>
      <ShowStateAsText>true</ShowStateAsText>
      <ShowZip>true</ShowZip>
      <Text>sample string 4</Text>
      <Value>sample string 1</Value>
    </Option>
  </BankAccountTypes>
  <BillTo>sample string 27</BillTo>
  <BillToCity>sample string 13</BillToCity>
  <BillToCountries>
    <Country>
      <Code>sample string 3</Code>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <RequireCity>true</RequireCity>
      <RequireState>true</RequireState>
      <RequireZip>true</RequireZip>
      <ShowCity>true</ShowCity>
      <ShowState>true</ShowState>
      <ShowStateAsText>true</ShowStateAsText>
      <ShowZip>true</ShowZip>
    </Country>
    <Country>
      <Code>sample string 3</Code>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <RequireCity>true</RequireCity>
      <RequireState>true</RequireState>
      <RequireZip>true</RequireZip>
      <ShowCity>true</ShowCity>
      <ShowState>true</ShowState>
      <ShowStateAsText>true</ShowStateAsText>
      <ShowZip>true</ShowZip>
    </Country>
  </BillToCountries>
  <BillToCountry>sample string 16</BillToCountry>
  <BillToState>sample string 14</BillToState>
  <BillToStates>
    <StateProvince>
      <Code>sample string 3</Code>
      <Country>sample string 4</Country>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </StateProvince>
    <StateProvince>
      <Code>sample string 3</Code>
      <Country>sample string 4</Country>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </StateProvince>
  </BillToStates>
  <BillToStreet1>sample string 11</BillToStreet1>
  <BillToStreet2>sample string 12</BillToStreet2>
  <BillToZip>sample string 15</BillToZip>
  <CSV>sample string 43</CSV>
  <CardNumber>sample string 41</CardNumber>
  <Credits>34</Credits>
  <Custom1>sample string 17</Custom1>
  <Custom2>sample string 18</Custom2>
  <Custom3>sample string 19</Custom3>
  <Custom4>sample string 20</Custom4>
  <Custom5>sample string 21</Custom5>
  <Custom6>sample string 22</Custom6>
  <CustomerId>sample string 29</CustomerId>
  <DatePaid>2025-12-05T21:39:44.9864217-06:00</DatePaid>
  <DefaultAccountingCompany>
    <AccountCompaniesName>sample string 1</AccountCompaniesName>
    <PayFieldsApiKey>sample string 2</PayFieldsApiKey>
    <PaymentAuthorizationMethod>sample string 3</PaymentAuthorizationMethod>
    <TestMode>true</TestMode>
  </DefaultAccountingCompany>
  <Description>sample string 24</Description>
  <Details i:nil="true" />
  <Discounts>35</Discounts>
  <DueDate>2025-12-05T21:39:44.9864217-06:00</DueDate>
  <Email>sample string 32</Email>
  <EntityType>sample string 55</EntityType>
  <ExpirationDate>sample string 42</ExpirationDate>
  <HasCustomInvoiceHtml>true</HasCustomInvoiceHtml>
  <HasRenewalWallet>true</HasRenewalWallet>
  <Id>sample string 30</Id>
  <InternationalAutocompleteUrl>sample string 4</InternationalAutocompleteUrl>
  <InvoiceDate>2025-12-05T21:39:44.9864217-06:00</InvoiceDate>
  <InvoiceHtml>sample string 25</InvoiceHtml>
  <InvoiceId>sample string 31</InvoiceId>
  <InvoiceNumber>sample string 33</InvoiceNumber>
  <InvoiceTotal>1</InvoiceTotal>
  <IsAutoPay>true</IsAutoPay>
  <IsDuesInvoice>true</IsDuesInvoice>
  <IsPPLInvoice>true</IsPPLInvoice>
  <LateBoundStatesAtCheckout>true</LateBoundStatesAtCheckout>
  <Name>sample string 23</Name>
  <NameOnCard>sample string 40</NameOnCard>
  <OptionalAddOnCategory>6083d6db-3082-4d2b-a77a-c46c5bb3491b</OptionalAddOnCategory>
  <PPD>sample string 51</PPD>
  <PPL>sample string 50</PPL>
  <PacHtml>sample string 52</PacHtml>
  <PaidThroughDate>2025-12-05T21:39:44.9864217-06:00</PaidThroughDate>
  <PayFieldsApiKey>sample string 45</PayFieldsApiKey>
  <PayFieldsEnvironment>sample string 46</PayFieldsEnvironment>
  <PaymentAmount>37</PaymentAmount>
  <PaymentOptions>
    <PaymentOption>
      <Id>sample string 1</Id>
      <Label>sample string 2</Label>
    </PaymentOption>
    <PaymentOption>
      <Id>sample string 1</Id>
      <Label>sample string 2</Label>
    </PaymentOption>
  </PaymentOptions>
  <PaymentType>44</PaymentType>
  <PaymentTypes>
    <Option>
      <Code>sample string 2</Code>
      <CountryId>sample string 3</CountryId>
      <RequireCity>true</RequireCity>
      <RequireState>true</RequireState>
      <RequireZip>true</RequireZip>
      <Selected>true</Selected>
      <ShowCity>true</ShowCity>
      <ShowState>true</ShowState>
      <ShowStateAsText>true</ShowStateAsText>
      <ShowZip>true</ShowZip>
      <Text>sample string 4</Text>
      <Value>sample string 1</Value>
    </Option>
    <Option>
      <Code>sample string 2</Code>
      <CountryId>sample string 3</CountryId>
      <RequireCity>true</RequireCity>
      <RequireState>true</RequireState>
      <RequireZip>true</RequireZip>
      <Selected>true</Selected>
      <ShowCity>true</ShowCity>
      <ShowState>true</ShowState>
      <ShowStateAsText>true</ShowStateAsText>
      <ShowZip>true</ShowZip>
      <Text>sample string 4</Text>
      <Value>sample string 1</Value>
    </Option>
  </PaymentTypes>
  <Payments i:nil="true" />
  <PrimaryMembershipId>3275a36b-ebc5-458f-85b8-622618465a7e</PrimaryMembershipId>
  <ReceiptType>38</ReceiptType>
  <SaveAsWalletText>sample string 53</SaveAsWalletText>
  <SelectedPaymentOption>sample string 9</SelectedPaymentOption>
  <ShipTo>sample string 28</ShipTo>
  <StatusReason>39</StatusReason>
  <UseAddressAutoComplete>true</UseAddressAutoComplete>
  <UseAddressValidation>true</UseAddressValidation>
  <UseInternational>true</UseInternational>
</Receipt>