ch.postfinance.sdk.service

Class TransactionInvoiceService

java.lang.Object

ch.postfinance.sdk.service.TransactionInvoiceService

public class TransactionInvoiceService
extends Object

Constructor Summary

Constructors

Constructor and Description
TransactionInvoiceService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Long	count(EntityQueryFilter filter, Long spaceId, Map<String,Object> params) Count Counts the number of items in the database as restricted by the given filter.
Long	count(Long spaceId, EntityQueryFilter filter) Count Counts the number of items in the database as restricted by the given filter.
com.google.api.client.http.HttpResponse	countForHttpResponse(EntityQueryFilter filter, Long spaceId, Map<String,Object> params)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, EntityQueryFilter filter)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, InputStream filter, String mediaType)
ApiClient	getApiClient()
RenderedDocument	getInvoiceDocument(Long spaceId, Long id) getInvoiceDocument Returns the PDF document for the transaction invoice with given id.
RenderedDocument	getInvoiceDocument(Long spaceId, Long id, Map<String,Object> params) getInvoiceDocument Returns the PDF document for the transaction invoice with given id.
com.google.api.client.http.HttpResponse	getInvoiceDocumentForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	getInvoiceDocumentForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
RenderedDocument	getInvoiceDocumentWithTargetMediaType(Long spaceId, Long id, Long targetMediaTypeId) getInvoiceDocumentWithTargetMediaType Returns the PDF document for the transaction invoice with given id and target media type id.
RenderedDocument	getInvoiceDocumentWithTargetMediaType(Long spaceId, Long id, Long targetMediaTypeId, Map<String,Object> params) getInvoiceDocumentWithTargetMediaType Returns the PDF document for the transaction invoice with given id and target media type id.
com.google.api.client.http.HttpResponse	getInvoiceDocumentWithTargetMediaTypeForHttpResponse(Long spaceId, Long id, Long targetMediaTypeId)
com.google.api.client.http.HttpResponse	getInvoiceDocumentWithTargetMediaTypeForHttpResponse(Long spaceId, Long id, Long targetMediaTypeId, Map<String,Object> params)
Boolean	isReplacementPossible(Long spaceId, Long id) isReplacementPossible Returns whether the transaction invoice with the given id can be replaced.
Boolean	isReplacementPossible(Long spaceId, Long id, Map<String,Object> params) isReplacementPossible Returns whether the transaction invoice with the given id can be replaced.
com.google.api.client.http.HttpResponse	isReplacementPossibleForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	isReplacementPossibleForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
TransactionInvoice	markAsDerecognized(Long spaceId, Long id) Mark as Derecognized Marks the transaction invoice with the given id as derecognized.
TransactionInvoice	markAsDerecognized(Long spaceId, Long id, Map<String,Object> params) Mark as Derecognized Marks the transaction invoice with the given id as derecognized.
com.google.api.client.http.HttpResponse	markAsDerecognizedForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	markAsDerecognizedForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
TransactionInvoice	markAsPaid(Long spaceId, Long id) Mark as Paid Marks the transaction invoice with the given id as paid.
TransactionInvoice	markAsPaid(Long spaceId, Long id, Map<String,Object> params) Mark as Paid Marks the transaction invoice with the given id as paid.
com.google.api.client.http.HttpResponse	markAsPaidForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	markAsPaidForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
TransactionInvoice	read(Long spaceId, Long id) Read Reads the entity with the given 'id' and returns it.
TransactionInvoice	read(Long spaceId, Long id, Map<String,Object> params) Read Reads the entity with the given 'id' and returns it.
com.google.api.client.http.HttpResponse	readForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	readForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
TransactionInvoice	replace(Long spaceId, Long id, TransactionInvoiceReplacement replacement) replace Replaces the transaction invoice with given id with the replacement and returns the new transaction invoice.
TransactionInvoice	replace(Long spaceId, Long id, TransactionInvoiceReplacement replacement, Map<String,Object> params) replace Replaces the transaction invoice with given id with the replacement and returns the new transaction invoice.
com.google.api.client.http.HttpResponse	replaceForHttpResponse(Long spaceId, Long id, InputStream replacement, String mediaType)
com.google.api.client.http.HttpResponse	replaceForHttpResponse(Long spaceId, Long id, TransactionInvoiceReplacement replacement)
com.google.api.client.http.HttpResponse	replaceForHttpResponse(Long spaceId, Long id, TransactionInvoiceReplacement replacement, Map<String,Object> params)
List<TransactionInvoice>	search(Long spaceId, EntityQuery query) Search Searches for the entities as specified by the given query.
List<TransactionInvoice>	search(Long spaceId, EntityQuery query, Map<String,Object> params) Search Searches for the entities as specified by the given query.
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query, Map<String,Object> params)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, InputStream query, String mediaType)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionInvoiceService

public TransactionInvoiceService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

count

public Long count(Long spaceId,
                  EntityQueryFilter filter)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

filter - The filter which restricts the entities which are used to calculate the count.

Returns:

Long

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Count Documentation

count

public Long count(EntityQueryFilter filter,
                  Long spaceId,
                  Map<String,Object> params)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Long

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Count Documentation

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    EntityQueryFilter filter)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    InputStream filter,
                                                                    String mediaType)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(EntityQueryFilter filter,
                                                                    Long spaceId,
                                                                    Map<String,Object> params)
                                                             throws IOException

Throws:

IOException

getInvoiceDocument

public RenderedDocument getInvoiceDocument(Long spaceId,
                                           Long id)
                                    throws IOException

getInvoiceDocument Returns the PDF document for the transaction invoice with given id.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice to get the document for.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getInvoiceDocument Documentation

getInvoiceDocument

public RenderedDocument getInvoiceDocument(Long spaceId,
                                           Long id,
                                           Map<String,Object> params)
                                    throws IOException

getInvoiceDocument Returns the PDF document for the transaction invoice with given id.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice to get the document for.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getInvoiceDocument Documentation

getInvoiceDocumentForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceDocumentForHttpResponse(Long spaceId,
                                                                                 Long id)
                                                                          throws IOException

Throws:

IOException

getInvoiceDocumentForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceDocumentForHttpResponse(Long spaceId,
                                                                                 Long id,
                                                                                 Map<String,Object> params)
                                                                          throws IOException

Throws:

IOException

getInvoiceDocumentWithTargetMediaType

public RenderedDocument getInvoiceDocumentWithTargetMediaType(Long spaceId,
                                                              Long id,
                                                              Long targetMediaTypeId)
                                                       throws IOException

getInvoiceDocumentWithTargetMediaType Returns the PDF document for the transaction invoice with given id and target media type id.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice to get the document for.

targetMediaTypeId - The id of the target media type for which the invoice should be generated for.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getInvoiceDocumentWithTargetMediaType Documentation

getInvoiceDocumentWithTargetMediaType

public RenderedDocument getInvoiceDocumentWithTargetMediaType(Long spaceId,
                                                              Long id,
                                                              Long targetMediaTypeId,
                                                              Map<String,Object> params)
                                                       throws IOException

getInvoiceDocumentWithTargetMediaType Returns the PDF document for the transaction invoice with given id and target media type id.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice to get the document for.

targetMediaTypeId - The id of the target media type for which the invoice should be generated for.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getInvoiceDocumentWithTargetMediaType Documentation

getInvoiceDocumentWithTargetMediaTypeForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceDocumentWithTargetMediaTypeForHttpResponse(Long spaceId,
                                                                                                    Long id,
                                                                                                    Long targetMediaTypeId)
                                                                                             throws IOException

Throws:

IOException

getInvoiceDocumentWithTargetMediaTypeForHttpResponse

public com.google.api.client.http.HttpResponse getInvoiceDocumentWithTargetMediaTypeForHttpResponse(Long spaceId,
                                                                                                    Long id,
                                                                                                    Long targetMediaTypeId,
                                                                                                    Map<String,Object> params)
                                                                                             throws IOException

Throws:

IOException

isReplacementPossible

public Boolean isReplacementPossible(Long spaceId,
                                     Long id)
                              throws IOException

isReplacementPossible Returns whether the transaction invoice with the given id can be replaced.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The invoice which should be checked if a replacement is possible.

Returns:

Boolean

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

isReplacementPossible Documentation

isReplacementPossible

public Boolean isReplacementPossible(Long spaceId,
                                     Long id,
                                     Map<String,Object> params)
                              throws IOException

isReplacementPossible Returns whether the transaction invoice with the given id can be replaced.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The invoice which should be checked if a replacement is possible.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Boolean

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

isReplacementPossible Documentation

isReplacementPossibleForHttpResponse

public com.google.api.client.http.HttpResponse isReplacementPossibleForHttpResponse(Long spaceId,
                                                                                    Long id)
                                                                             throws IOException

Throws:

IOException

isReplacementPossibleForHttpResponse

public com.google.api.client.http.HttpResponse isReplacementPossibleForHttpResponse(Long spaceId,
                                                                                    Long id,
                                                                                    Map<String,Object> params)
                                                                             throws IOException

Throws:

IOException

markAsDerecognized

public TransactionInvoice markAsDerecognized(Long spaceId,
                                             Long id)
                                      throws IOException

Mark as Derecognized Marks the transaction invoice with the given id as derecognized.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice which should be marked as derecognized.

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Mark as Derecognized Documentation

markAsDerecognized

public TransactionInvoice markAsDerecognized(Long spaceId,
                                             Long id,
                                             Map<String,Object> params)
                                      throws IOException

Mark as Derecognized Marks the transaction invoice with the given id as derecognized.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice which should be marked as derecognized.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Mark as Derecognized Documentation

markAsDerecognizedForHttpResponse

public com.google.api.client.http.HttpResponse markAsDerecognizedForHttpResponse(Long spaceId,
                                                                                 Long id)
                                                                          throws IOException

Throws:

IOException

markAsDerecognizedForHttpResponse

public com.google.api.client.http.HttpResponse markAsDerecognizedForHttpResponse(Long spaceId,
                                                                                 Long id,
                                                                                 Map<String,Object> params)
                                                                          throws IOException

Throws:

IOException

markAsPaid

public TransactionInvoice markAsPaid(Long spaceId,
                                     Long id)
                              throws IOException

Mark as Paid Marks the transaction invoice with the given id as paid.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice which should be marked as paid.

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Mark as Paid Documentation

markAsPaid

public TransactionInvoice markAsPaid(Long spaceId,
                                     Long id,
                                     Map<String,Object> params)
                              throws IOException

Mark as Paid Marks the transaction invoice with the given id as paid.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoice which should be marked as paid.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Mark as Paid Documentation

markAsPaidForHttpResponse

public com.google.api.client.http.HttpResponse markAsPaidForHttpResponse(Long spaceId,
                                                                         Long id)
                                                                  throws IOException

Throws:

IOException

markAsPaidForHttpResponse

public com.google.api.client.http.HttpResponse markAsPaidForHttpResponse(Long spaceId,
                                                                         Long id,
                                                                         Map<String,Object> params)
                                                                  throws IOException

Throws:

IOException

read

public TransactionInvoice read(Long spaceId,
                               Long id)
                        throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoices which should be returned.

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

read

public TransactionInvoice read(Long spaceId,
                               Long id,
                               Map<String,Object> params)
                        throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoices which should be returned.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(Long spaceId,
                                                                   Long id)
                                                            throws IOException

Throws:

IOException

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(Long spaceId,
                                                                   Long id,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

replace

public TransactionInvoice replace(Long spaceId,
                                  Long id,
                                  TransactionInvoiceReplacement replacement)
                           throws IOException

replace Replaces the transaction invoice with given id with the replacement and returns the new transaction invoice.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoices which should be replaced.

replacement -

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

replace Documentation

replace

public TransactionInvoice replace(Long spaceId,
                                  Long id,
                                  TransactionInvoiceReplacement replacement,
                                  Map<String,Object> params)
                           throws IOException

replace Replaces the transaction invoice with given id with the replacement and returns the new transaction invoice.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the transaction invoices which should be replaced.

replacement -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

TransactionInvoice

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

replace Documentation

replaceForHttpResponse

public com.google.api.client.http.HttpResponse replaceForHttpResponse(Long spaceId,
                                                                      Long id,
                                                                      TransactionInvoiceReplacement replacement)
                                                               throws IOException

Throws:

IOException

replaceForHttpResponse

public com.google.api.client.http.HttpResponse replaceForHttpResponse(Long spaceId,
                                                                      Long id,
                                                                      InputStream replacement,
                                                                      String mediaType)
                                                               throws IOException

Throws:

IOException

replaceForHttpResponse

public com.google.api.client.http.HttpResponse replaceForHttpResponse(Long spaceId,
                                                                      Long id,
                                                                      TransactionInvoiceReplacement replacement,
                                                                      Map<String,Object> params)
                                                               throws IOException

Throws:

IOException

search

public List<TransactionInvoice> search(Long spaceId,
                                       EntityQuery query)
                                throws IOException

Search Searches for the entities as specified by the given query.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

query - The query restricts the transaction invoices which are returned by the search.

Returns:

List<TransactionInvoice>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Search Documentation

search

public List<TransactionInvoice> search(Long spaceId,
                                       EntityQuery query,
                                       Map<String,Object> params)
                                throws IOException

Search Searches for the entities as specified by the given query.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

query - The query restricts the transaction invoices which are returned by the search.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

List<TransactionInvoice>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Search Documentation

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     EntityQuery query)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     InputStream query,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     EntityQuery query,
                                                                     Map<String,Object> params)
                                                              throws IOException

Throws:

IOException