This session creates, updates, and deletes Receipts in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Receipt, a ReceiptForm is requested using getReceiptFormsForCreate() specifying the desired Messages and record Types or none if no record Types are needed. Each of the returned ReceiptForms will indicate that it is to be used with a create operation and can be used to examine metadata or validate data prior to creation. Once a ReceiptForm is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ReceiptForm corresponds to an attempted transaction.

The ReceiptForms returned from getReceiptFormsForCreate() may be linked to the originating request through the Message Id of the ReceiptForm. In the case where there may be duplicates, any ReceiptForm of the same Message Id may be used for a create operation.

Once a batch of ReceiptForms are submitted for create, a CreateResponse is returned for each ReceiptForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createReceipts(), errors specific to an individual ReceiptForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating ReceiptForm through the ReceiptForm Id.

For updates, ReceiptForms are requested to the Receipt Id that is to be updated using getReceiptFormsForUpdate() where the reference Id in the ReceiptForm may be used to link the request. Similarly, the ReceiptForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ReceiptForm can only be used once for a successful update and cannot be reused.

Once a batch of ReceiptForms are submitted for update, an UpdateResponse is returned for each ReceiptForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateReceipts(), errors specific to an individual ReceiptForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating ReceiptForm through the ReceiptForm Id.

The delete operations delete Receipts in bulk. These delete operations attempt to remove the Receipt itself thus removing it from all known Mailbox catalogs. Bulk delete operations return the results in DeleteResponses.

Like all OsidSessions, ReceiptBatchAdminSessions are dedicated to single processing threads and a single authenticated user.