data-and-reporting-sdk/src/models/invoiceDownloadReq.ts

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication

/**
 * Shell Data & Reporting APIsLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import {
  array,
  nullable,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema';

export interface InvoiceDownloadReq {
  /**
   * Collecting Company Code of the selected payer.
   * Mandatory
   */
  colCoCode: number | null;
  /**
   * Payer Number of the selected payer.
   * Mandatory
   * Example: GB000000123
   */
  payerNumber: string | null;
  /**
   * List of Account Numbers of the invoices.
   * Mandatory for customer users else optional.
   */
  accountNumber?: string[];
  /**
   * Unique reference ids of invoice document (of zip file).
   * Optional if InvoiceOrSOANumber is passed else Mandatory.
   */
  documentReference?: number[];
  /** Invoice or the SOA document reference number issued by Card s Platform. */
  invoiceOrSOANumber?: string | null;
}

export const invoiceDownloadReqSchema: Schema<InvoiceDownloadReq> = object({
  colCoCode: ['ColCoCode', nullable(number())],
  payerNumber: ['PayerNumber', nullable(string())],
  accountNumber: ['AccountNumber', optional(array(string()))],
  documentReference: ['DocumentReference', optional(array(number()))],
  invoiceOrSOANumber: ['InvoiceOrSOANumber', optional(nullable(string()))],
});