PushPayments

Pushes service payments for ROs and parts invoices.

Request Information

Parameters

Collection of PaymentPushRequest

Name	Description	Type	Additional information
ServiceLocationId		integer
EventType		ServiceEventType
EventKey		string
ReceiptType		string
Payments		Collection of PushedPayment

Sample Request

<ArrayOfPaymentPushRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <PaymentPushRequest>
    <EventKey>sample string 2</EventKey>
    <EventType>RepairOrder</EventType>
    <Payments>
      <PushedPayment>
        <Amount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </Amount>
        <Attributes>
          <Control2>sample string 1</Control2>
        </Attributes>
        <Description>sample string 6</Description>
        <ExternalPaymentId>sample string 2</ExternalPaymentId>
        <IsRefund>true</IsRefund>
        <PaymentKey>sample string 1</PaymentKey>
        <PaymentMethodKey>sample string 3</PaymentMethodKey>
        <Username>sample string 4</Username>
      </PushedPayment>
      <PushedPayment>
        <Amount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </Amount>
        <Attributes>
          <Control2>sample string 1</Control2>
        </Attributes>
        <Description>sample string 6</Description>
        <ExternalPaymentId>sample string 2</ExternalPaymentId>
        <IsRefund>true</IsRefund>
        <PaymentKey>sample string 1</PaymentKey>
        <PaymentMethodKey>sample string 3</PaymentMethodKey>
        <Username>sample string 4</Username>
      </PushedPayment>
    </Payments>
    <ReceiptType>sample string 3</ReceiptType>
    <ServiceLocationId>1</ServiceLocationId>
  </PaymentPushRequest>
  <PaymentPushRequest>
    <EventKey>sample string 2</EventKey>
    <EventType>RepairOrder</EventType>
    <Payments>
      <PushedPayment>
        <Amount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </Amount>
        <Attributes>
          <Control2>sample string 1</Control2>
        </Attributes>
        <Description>sample string 6</Description>
        <ExternalPaymentId>sample string 2</ExternalPaymentId>
        <IsRefund>true</IsRefund>
        <PaymentKey>sample string 1</PaymentKey>
        <PaymentMethodKey>sample string 3</PaymentMethodKey>
        <Username>sample string 4</Username>
      </PushedPayment>
      <PushedPayment>
        <Amount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </Amount>
        <Attributes>
          <Control2>sample string 1</Control2>
        </Attributes>
        <Description>sample string 6</Description>
        <ExternalPaymentId>sample string 2</ExternalPaymentId>
        <IsRefund>true</IsRefund>
        <PaymentKey>sample string 1</PaymentKey>
        <PaymentMethodKey>sample string 3</PaymentMethodKey>
        <Username>sample string 4</Username>
      </PushedPayment>
    </Payments>
    <ReceiptType>sample string 3</ReceiptType>
    <ServiceLocationId>1</ServiceLocationId>
  </PaymentPushRequest>
</ArrayOfPaymentPushRequest>

Response Information

Resource Description

Collection of PaymentPushResponse

Name	Description	Type	Additional information
EventType		ServiceEventType
EventKey		string
Balance		MonetaryValue
PayTypeStatuses		Collection of PayTypeStatus
Payments		Collection of PushResponse
ServiceLocationId		integer

Sample Response

<ArrayOfPaymentPushResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <PaymentPushResponse>
    <Balance xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:Amount>1</d3p1:Amount>
      <d3p1:Currency>UsDollar</d3p1:Currency>
    </Balance>
    <EventKey>sample string 1</EventKey>
    <EventType>RepairOrder</EventType>
    <PayTypeStatuses xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models.Accounting">
      <d3p1:PayTypeStatus>
        <d3p1:BalanceDue xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:BalanceDue>
        <d3p1:OriginalAmount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:OriginalAmount>
        <d3p1:PayType>Unknown</d3p1:PayType>
      </d3p1:PayTypeStatus>
      <d3p1:PayTypeStatus>
        <d3p1:BalanceDue xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:BalanceDue>
        <d3p1:OriginalAmount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:OriginalAmount>
        <d3p1:PayType>Unknown</d3p1:PayType>
      </d3p1:PayTypeStatus>
    </PayTypeStatuses>
    <Payments>
      <PushResponse>
        <ExternalRecordId>sample string 3</ExternalRecordId>
        <Message>sample string 2</Message>
        <PushResult>Unprocessed</PushResult>
        <PushedRecordKey>sample string 1</PushedRecordKey>
      </PushResponse>
      <PushResponse>
        <ExternalRecordId>sample string 3</ExternalRecordId>
        <Message>sample string 2</Message>
        <PushResult>Unprocessed</PushResult>
        <PushedRecordKey>sample string 1</PushedRecordKey>
      </PushResponse>
    </Payments>
    <ServiceLocationId>2</ServiceLocationId>
  </PaymentPushResponse>
  <PaymentPushResponse>
    <Balance xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:Amount>1</d3p1:Amount>
      <d3p1:Currency>UsDollar</d3p1:Currency>
    </Balance>
    <EventKey>sample string 1</EventKey>
    <EventType>RepairOrder</EventType>
    <PayTypeStatuses xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models.Accounting">
      <d3p1:PayTypeStatus>
        <d3p1:BalanceDue xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:BalanceDue>
        <d3p1:OriginalAmount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:OriginalAmount>
        <d3p1:PayType>Unknown</d3p1:PayType>
      </d3p1:PayTypeStatus>
      <d3p1:PayTypeStatus>
        <d3p1:BalanceDue xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:BalanceDue>
        <d3p1:OriginalAmount xmlns:d5p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
          <d5p1:Amount>1</d5p1:Amount>
          <d5p1:Currency>UsDollar</d5p1:Currency>
        </d3p1:OriginalAmount>
        <d3p1:PayType>Unknown</d3p1:PayType>
      </d3p1:PayTypeStatus>
    </PayTypeStatuses>
    <Payments>
      <PushResponse>
        <ExternalRecordId>sample string 3</ExternalRecordId>
        <Message>sample string 2</Message>
        <PushResult>Unprocessed</PushResult>
        <PushedRecordKey>sample string 1</PushedRecordKey>
      </PushResponse>
      <PushResponse>
        <ExternalRecordId>sample string 3</ExternalRecordId>
        <Message>sample string 2</Message>
        <PushResult>Unprocessed</PushResult>
        <PushedRecordKey>sample string 1</PushedRecordKey>
      </PushResponse>
    </Payments>
    <ServiceLocationId>2</ServiceLocationId>
  </PaymentPushResponse>
</ArrayOfPaymentPushResponse>