SBReceipt

Objective-C

@interface SBReceipt : NSObject <NSSecureCoding>

Swift

class SBReceipt : NSObject, NSSecureCoding

Details of a single processed receipt

  • ID

    A unique identifier of the receipt.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *ID;

    Swift

    var id: String? { get set }

  • The merchant that issued the receipt

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *merchantName;

    Swift

    var merchantName: String? { get set }

  • The date on the receipt

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDate *date;

    Swift

    var date: Date? { get set }

  • The date used when sorting receipts. Is set to SBReceipt.date, if available. Otherwise, is set to a date when receipt was uploaded.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSDate *listingSortDate;

    Swift

    var listingSortDate: Date { get set }

  • The date on which receipt was uploaded

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDate *arrivalTime;

    Swift

    var arrivalTime: Date? { get set }

  • Indicates whether receipt was added recently

    Declaration

    Objective-C

    @property (nonatomic) BOOL recentlyAdded;

    Swift

    var recentlyAdded: Bool { get set }

  • True if receipt is pending validation (some required fields are missing)

    Declaration

    Objective-C

    @property (nonatomic) BOOL isValidationRequired;

    Swift

    var isValidationRequired: Bool { get set }

  • A list of receipt folders

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSMutableArray<NSString *> *folders;

    Swift

    var folders: NSMutableArray { get set }

  • The amount to show as the tip (gratuity)

    Declaration

    Objective-C

    @property (nonatomic) CGFloat tipAmount;

    Swift

    var tipAmount: CGFloat { get set }

  • The grand total

    Declaration

    Objective-C

    @property (nonatomic) CGFloat amount;

    Swift

    var amount: CGFloat { get set }

  • The amount to show as the subtotal

    Declaration

    Objective-C

    @property (nonatomic) CGFloat subTotalAmount;

    Swift

    var subTotalAmount: CGFloat { get set }

  • True, if subTotalAmount is missing

    Declaration

    Objective-C

    @property (nonatomic) BOOL isSubtotalEmpty;

    Swift

    var isSubtotalEmpty: Bool { get set }

  • Net total amount on UK receipts

    Declaration

    Objective-C

    @property (nonatomic) CGFloat netTotalAmount;

    Swift

    var netTotalAmount: CGFloat { get set }

  • True, if netTotalAmount is missing

    Declaration

    Objective-C

    @property (nonatomic) BOOL isNetTotalEmpty;

    Swift

    var isNetTotalEmpty: Bool { get set }

  • The amount to show as the sum of all taxes

    Declaration

    Objective-C

    @property (nonatomic) CGFloat taxAmount;

    Swift

    var taxAmount: CGFloat { get set }

  • Number of extracted taxes

    Declaration

    Objective-C

    @property (nonatomic) NSInteger numExtractedTaxes;

    Swift

    var numExtractedTaxes: Int { get set }

  • Receipt tax detail.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSArray<SBLTax *> *taxes;

    Swift

    var taxes: [SBLTax] { get set }

    Return Value

    returns the taxes detail.

  • Receipt UI Display Format

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SBReceiptUIDisplay *detailDisplay;

    Swift

    var detailDisplay: SBReceiptUIDisplay? { get set }

    Return Value

    returns the display format used for rendering in a detail view

  • Receipt Category.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *category;

    Swift

    var category: String? { get set }

    Return Value

    returns the receipt category

  • Receipt Currency Code.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *currencyCode;

    Swift

    var currencyCode: String? { get set }

    Return Value

    returns the receipt currency Code

  • Receipt Country Code.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *countryCode;

    Swift

    var countryCode: String? { get set }

    Return Value

    returns the receipt country Code

  • Receipt render URL.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *renderURL;

    Swift

    var renderURL: String? { get set }

    Return Value

    returns the receipt’s image URL

  • Receipt render URL Type.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *renderURLType;

    Swift

    var renderURLType: String? { get set }

    Return Value

    returns the receipt’s image URL Type

Merchant

  • Merchant’s ID

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *merchantID;

    Swift

    var merchantID: String? { get set }

    Return Value

    returns merchant’s ID

Shared Metadata

  • Receipt shared metadata’s note.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *note;

    Swift

    var note: String? { get set }

    Return Value

    returns the receipt’s shared metadata’s note

  • Receipt Email ID

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *receiptEmailID;

    Swift

    var receiptEmailID: String? { get set }

    Return Value

    returns Receipt Email ID

  • Receipt shared metadata’s expense type.

    Declaration

    Objective-C

    @property (nonatomic) SBLReceiptExpenseType expenseType;

    Return Value

    returns the receipt’s shared metadata’s expense type

Additional Properties

  • Receipt Folder Colors.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSMutableArray<UIColor *> *folderColors;

    Swift

    var folderColors: NSMutableArray { get set }

    Return Value

    returns a a list of UIColors available for folders

  • A list of the reminders

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSMutableArray<SBReminder *> *reminders;

    Swift

    var reminders: NSMutableArray? { get set }

  • Return/exchange time period

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SBLDatePeriod *returnExchangePeriod;

    Swift

    var returnExchangePeriod: SBLDatePeriod? { get set }

  • Warranty time period

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SBLDatePeriod *warrantyPeriod;

    Swift

    var warrantyPeriod: SBLDatePeriod? { get set }

  • Allows to specify receipt’s external account transaction id

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SBLPrivateMetaData *privateMetaData;

    Swift

    var privateMetaData: SBLPrivateMetaData? { get set }

Manager

  • Save receipts to persistent store

    Declaration

    Objective-C

    + (BOOL)saveReceipts:(NSMutableArray *_Nonnull)receipts;

    Swift

    class func saveReceipts(_ receipts: NSMutableArray) -> Bool

  • Get all receipts from persistent store

    Declaration

    Objective-C

    + (NSMutableArray *_Nonnull)getAllReceipts;

    Swift

    class func getAllReceipts() -> NSMutableArray

  • Default total amount set when no value is returned from the server

    Declaration

    Objective-C

    + (CGFloat)defaultAmountValue;

    Swift

    class func defaultAmountValue() -> CGFloat