@paciolan/cybersource-sdk/dist/models/ptsv2paymentsidcaptures-order-information-invoice-details.d.ts

CyberSource REST API Typescript SDK

/**
 * CyberSource Merged Spec
 * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum } from './ptsv2payments-order-information-invoice-details-transaction-advice-addendum';
/**
 *
 * @export
 * @interface Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
 */
export interface Ptsv2paymentsidcapturesOrderInformationInvoiceDetails {
    /**
     * Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines.  For processor-specific information, see the `user_po` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
     * @type {string}
     * @memberof Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
     */
    purchaseOrderNumber?: string;
    /**
     * Date the order was processed. `Format: YYYY-MM-DD`.  For processor-specific information, see the `purchaser_order_date` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
     * @type {string}
     * @memberof Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
     */
    purchaseOrderDate?: string;
    /**
     * The name of the individual or the company contacted for company authorized purchases.  For processor-specific information, see the `authorized_contact_name` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
     * @type {string}
     * @memberof Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
     */
    purchaseContactName?: string;
    /**
     * Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.  If you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor.  For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)  Possible values:  - **true**  - **false**
     * @type {boolean}
     * @memberof Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
     */
    taxable?: boolean;
    /**
     * VAT invoice number associated with the transaction.  For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
     * @type {string}
     * @memberof Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
     */
    vatInvoiceReferenceNumber?: string;
    /**
     * International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes.  For processor-specific information, see the `summary_commodity_code` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
     * @type {string}
     * @memberof Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
     */
    commodityCode?: string;
    /**
     *
     * @type {Array<Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>}
     * @memberof Ptsv2paymentsidcapturesOrderInformationInvoiceDetails
     */
    transactionAdviceAddendum?: Array<Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>;
}