PM-4961 Fetch Billing account details api

Author: himaniraghav3

.circleci/config.yml

@@ -64,7 +64,7 @@ workflows:
           branches:
             only:
               - develop
-              - PM-4949
+              - PM-4961
 
     # Production builds are exectuted only on tagged commits to the
     # master branch.

sql/reports/sfdc/billing-account-detail.sql

@@ -0,0 +1,11 @@
+SELECT
+  ba.name,
+  ba.description,
+  ba."subcontractingEndCustomer" AS "subcontractingEndCustomer",
+  ba.status::text AS status,
+  ba."startDate" AS "startDate",
+  ba."endDate" AS "endDate",
+  ba.budget,
+  ba.markup
+FROM "billing-accounts"."BillingAccount" ba
+WHERE ba.id::text = TRIM($1)

src/reports/sfdc/sfdc-reports.controller.ts

@@ -23,6 +23,8 @@ import { SfdcReportsService } from "./sfdc-reports.service";
 import {
   BaFeesReportQueryDto,
   BaFeesReportResponse,
+  BillingAccountProfileQueryDto,
+  BillingAccountProfileResponse,
   ChallengesReportQueryDto,
   ChallengesReportResponse,
   PaymentsReportQueryDto,
@@ -83,6 +85,24 @@ export class SfdcReportsController {
     return report;
   }
 
+  @Get("/billing-accounts")
+  @UseGuards(PermissionsGuard)
+  @Scopes(AppScopes.AllReports, AppScopes.SFDC.PaymentsReport)
+  @ApiBearerAuth()
+  @ApiOperation({
+    summary: "Billing account profile",
+    description:
+      "Returns billing account metadata from billing-accounts.BillingAccount when the ID exists.",
+  })
+  @ApiResponse({
+    status: 200,
+    description: "Billing account profile retrieved successfully",
+    type: ResponseDto<BillingAccountProfileResponse>,
+  })
+  async getBillingAccountProfile(@Query() query: BillingAccountProfileQueryDto) {
+    return this.reportsService.getBillingAccountProfile(query);
+  }
+
   @Get("/taas/jobs")
   @UseGuards(PermissionsGuard)
   @Scopes(AppScopes.AllReports, AppScopes.SFDC.TaasJobs)

src/reports/sfdc/sfdc-reports.dto.ts

@@ -350,6 +350,55 @@ export class PaymentsReportResponse {
   challengeStatus: string | null;
 }
 
+export class BillingAccountProfileQueryDto {
+  @ApiProperty({
+    required: true,
+    description:
+      "Billing account identifier (matches finance.payment.billing_account and billing-accounts.BillingAccount.id)",
+    example: "80004349",
+  })
+  @Transform(({ value }) => (typeof value === "string" ? value.trim() : value))
+  @IsString()
+  @IsNotEmpty()
+  billingAccountId: string;
+}
+
+export class BillingAccountDetailResponse {
+  @ApiProperty()
+  name: string;
+
+  @ApiProperty({ nullable: true, type: String })
+  description: string | null;
+
+  @ApiProperty({ nullable: true, type: String })
+  subcontractingEndCustomer: string | null;
+
+  @ApiProperty()
+  status: string;
+
+  @ApiProperty({ nullable: true, type: String })
+  startDate: string | null;
+
+  @ApiProperty({ nullable: true, type: String })
+  endDate: string | null;
+
+  @ApiProperty()
+  budget: string;
+
+  @ApiProperty()
+  markup: string;
+}
+
+export class BillingAccountProfileResponse {
+  @ApiProperty({
+    nullable: true,
+    type: BillingAccountDetailResponse,
+    description:
+      "Row from billing-accounts.BillingAccount when the ID exists; null if unknown.",
+  })
+  billingAccount: BillingAccountDetailResponse | null;
+}
+
 export class TaasJobsReportQueryDto {
   @ApiProperty({
     required: false,

src/reports/sfdc/sfdc-reports.service.ts

@@ -4,6 +4,8 @@ import { Logger } from "src/common/logger";
 import {
   BaFeesReportQueryDto,
   BaFeesReportResponse,
+  BillingAccountProfileQueryDto,
+  BillingAccountProfileResponse,
   ChallengesFilterMode,
   ChallengesReportQueryDto,
   ChallengesReportResponse,
@@ -137,6 +139,21 @@ export class SfdcReportsService {
     }));
   }
 
+  async getBillingAccountProfile(
+    filters: BillingAccountProfileQueryDto,
+  ): Promise<BillingAccountProfileResponse> {
+    const billingAccountId = filters.billingAccountId.trim();
+    const query = this.sql.load("reports/sfdc/billing-account-detail.sql");
+    const rows = await this.db.query<BillingAccountProfileResponse["billingAccount"]>(
+      query,
+      [billingAccountId],
+    );
+
+    return {
+      billingAccount: rows[0] ?? null,
+    };
+  }
+
   async getTaasJobsReport(filters: TaasJobsReportQueryDto) {
     this.logger.debug("Starting getTaasJobsReport with filters:", filters);