POST Sync/OnInvoiceEmailRequested

This method sends the invoice email with the pdf attachment (in bytes) to the recipient(s)

Request Information

URI Parameters

None.

Body Parameters

Contains the pdf attachment data and the clients to send the email to. Also contains the subscriber id to build the environment context

InvoiceEmailRequestedSyncEvent
NameDescriptionTypeAdditional information
OnInvoiceEmailRequestedEvent

The event that will be passed on directly to Marketplace that contains all pertinent email information.

OnInvoiceEmailRequestedEvent

None.

SubscriberId

The subscriber id to build the environment context on.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "OnInvoiceEmailRequestedEvent": {
    "InvoicePdfBytes": "QEA=",
    "ConsumerIds": [
      1,
      2
    ],
    "LocationId": 1,
    "InvoicePdfFileName": "sample string 2",
    "InvoiceDate": "2024-09-29T06:23:04.16906-07:00"
  },
  "SubscriberId": 1
}

application/xml, text/xml

Sample:
<InvoiceEmailRequestedSyncEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Api.Subscriber.Areas.Sync.Models">
  <OnInvoiceEmailRequestedEvent xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Events.Invoices">
    <d2p1:ConsumerIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:ConsumerIds>
    <d2p1:InvoiceDate>2024-09-29T06:23:04.16906-07:00</d2p1:InvoiceDate>
    <d2p1:InvoicePdfBytes>QEA=</d2p1:InvoicePdfBytes>
    <d2p1:InvoicePdfFileName>sample string 2</d2p1:InvoicePdfFileName>
    <d2p1:LocationId>1</d2p1:LocationId>
  </OnInvoiceEmailRequestedEvent>
  <SubscriberId>1</SubscriberId>
</InvoiceEmailRequestedSyncEvent>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.