Package org.oxerr.stubhub.client.cxf.resource

Interface InvoiceResource

@Path("/invoices")
@Produces("application/json")
@Consumes("application/json")
public interface InvoiceResource

Method Summary

Modifier and Type	Method	Description
InvoiceExportResponse	export(OffsetDateTime updateDateSince, OffsetDateTime updateDateTo, Long updateDatePaginationToken, OffsetDateTime createdDateFrom, OffsetDateTime createdDateTo, OffsetDateTime createdDatePaginationToken, Integer maxPageSize, Boolean includeWastedSales)	Get all invoices with pagination.
SaleResponse	getInvoiceById(Long invoiceId, Boolean includeMarketplaceOriginalSeating, Boolean includeBuyerCommissionsPerTicket)	Retrieves an invoice by the invoice id
List<SaleResponse>	getInvoicesByMarketplaceSaleId(String marketplaceSaleId)	Retrieves invoices by the marketplaceSaleId across all marketplaces

Method Details

getInvoicesByMarketplaceSaleId

@GET
@Path("/marketplace/{marketplaceSaleId}")
List<SaleResponse> getInvoicesByMarketplaceSaleId(@PathParam("marketplaceSaleId")
 String marketplaceSaleId)

Retrieves invoices by the marketplaceSaleId across all marketplaces

200 - Success

Parameters:

marketplaceSaleId - The sale id of the marketplace (required)

Returns:

invoices by the marketplaceSaleId across all marketplaces

getInvoiceById

@GET
@Path("/{invoiceId}")
SaleResponse getInvoiceById(@PathParam("invoiceId")
 Long invoiceId,
 @QueryParam("includeMarketplaceOriginalSeating")
 Boolean includeMarketplaceOriginalSeating,
 @QueryParam("includeBuyerCommissionsPerTicket")
 Boolean includeBuyerCommissionsPerTicket)

Retrieves an invoice by the invoice id

400 - Bad Request

200 - Success

Parameters:

invoiceId - The id of the invoice (required)

includeMarketplaceOriginalSeating - To include the original requested seating from Marketplace (optional)

includeBuyerCommissionsPerTicket - To include buyerCommissionsArray per Ticket. Default is false (optional)

Returns:

an invoice by the invoice id

export

@GET
@Path("/export")
InvoiceExportResponse export(@QueryParam("updateDateSince")
 OffsetDateTime updateDateSince,
 @QueryParam("updateDateTo")
 OffsetDateTime updateDateTo,
 @QueryParam("updateDatePaginationToken")
 Long updateDatePaginationToken,
 @QueryParam("createdDateFrom")
 OffsetDateTime createdDateFrom,
 @QueryParam("createdDateTo")
 OffsetDateTime createdDateTo,
 @QueryParam("createdDatePaginationToken")
 OffsetDateTime createdDatePaginationToken,
 @QueryParam("maxPageSize")
 Integer maxPageSize,
 @QueryParam("includeWastedSales")
 Boolean includeWastedSales)

Get all invoices with pagination. Can filter off of update date from/to and create date from/to. If none is provided, the default pagination token = 0 will be used.

400 - Bad Request

200 - Success

Parameters:

updateDateSince - The beginning update date to be used for looking up invoices. Must be in the format yyyy-MM-ddTHH:mm:ss. (optional)

updateDateTo - The ending update date to be used for looking up invoices. Must be in the format yyyy-MM-ddTHH:mm:ss. (optional)

updateDatePaginationToken - Pagination token based off of update date. Cannot set updateDatePaginationToken and createDatePaginationToken both at the same time. (optional)

createdDateFrom - The beginning create date to be used for looking up invoices. Must be in the format yyyy-MM-ddTHH:mm:ss (optional)

createdDateTo - The end create date to be used for looking up invoices. Must be in the format yyyy-MM-ddTHH:mm:ss (optional)

createdDatePaginationToken - Pagination token based off of create date. Cannot set updateDatePaginationToken and createDatePaginationToken both at the same time. Can safely set createdDatePaginationToken to same value as createdDate to trigger order by create date. (optional)

maxPageSize - The maximum number of result per page. Default is 100 and Max Page Size is 5000. (optional)

includeWastedSales - To include wasted sales. Default is false (optional)

Returns:

invoices.