@cfxlabsinc/b2b-services
    Preparing search index...

    Read side of Green Dot's settlement batches, for the admin dashboard.

    Index
    instance: (...args: []) => GreendotSettlementBatchQueryService = ...

    The process default, over the shared database.

    • Parameters

      • __namedParameters: {
            excludeZeroTotal?: boolean;
            fileDate?: { from?: PlainDate; to?: PlainDate };
            ids?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                adviceObjectKey: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                adviceTotalAmount: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    PgNumericBuilder,
                                    {
                                        data: string;
                                        dataType: "string numeric";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                createdAt: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                detailObjectKey: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                entryCount: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetHasRuntimeDefault<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                fileDate: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetNotNull<PgDateStringBuilder>,
                                    {
                                        data: string;
                                        dataType: "string date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: "byDefault";
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                partner: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                processor: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                program: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                settlementAccount: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                status: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                totalAmount: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string numeric";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                transmissionId: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "greendot_settlement_batch",
                                    SetHasDefault<SetHasDefault<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "greendot_settlement_batch";
                                    },
                                >;
                            };
                            dialect: "pg";
                            isAlias: false;
                            name: "greendot_settlement_batch";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "totalAmount"
                | "fileDate"
                | "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            q?: string;
            reconciled?: boolean;
            statuses?: SettlementBatchStatus[];
        }
        • OptionalexcludeZeroTotal?: boolean

          Leave out batches whose entries total zero.

        • OptionalfileDate?: { from?: PlainDate; to?: PlainDate }

          Inclusive on both ends.

        • Optionalids?: string[]
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              adviceObjectKey: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              adviceTotalAmount: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  PgNumericBuilder,
                                  {
                                      data: string;
                                      dataType: "string numeric";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              detailObjectKey: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              entryCount: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetHasRuntimeDefault<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              fileDate: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetNotNull<PgDateStringBuilder>,
                                  {
                                      data: string;
                                      dataType: "string date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: "byDefault";
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              partner: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              processor: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              program: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              settlementAccount: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              totalAmount: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string numeric";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              transmissionId: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "greendot_settlement_batch",
                                  SetHasDefault<SetHasDefault<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "greendot_settlement_batch";
                                  },
                              >;
                          };
                          dialect: "pg";
                          isAlias: false;
                          name: "greendot_settlement_batch";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "totalAmount"
              | "fileDate"
              | "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number

          Defaults to 1.

        • OptionalpageSize?: number

          Defaults to 50.

        • Optionalq?: string

          Exact match on the batch id, transmission id or reconciling credit id, or on an entry's transaction reference, deposit id or quote id. The batch table has no search document.

        • Optionalreconciled?: boolean

          Whether a credit reconciles the batch.

        • Optionalstatuses?: SettlementBatchStatus[]

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: GreendotSettlementBatch[];
                  total: number;
              };
          },
      >