---
# System prepended metadata

title: Backoffice endpoints

---

# Backoffice endpoints
## POST /api/v1/financial-managers/auth/login
````typescript
type Response = {
  accessToken: string;
  refreshToken: string;
}
````

## GET /api/v1/financial-manager/transactions/:transactionId
````typescript

type Response = {
  transactionId: string;
  billerName: string;
  clientIdentifier: {
    type: ClientIdentifierType;
    value: string;
  };
  createdAt: Date;
  shopOwner: {
    name: string;
    phoneNumber: string;
    email: string;
  };
  shopAddress: Address;
  status: TransactionState;
  historic: TransactionEvent[];
  payment: {
    concept: string;
    method: PaymentMethod;
    amount: number;
    amountPaidByClient: number;
    debtFromArcus: number;
    shopOwnerCommission: number;
    benefits: number;
  }
}
````

## GET /api/v1/shops
````typescript
type Response = Shop[]
````

## GET /api/v1/shops/:shopId
````typescript
type Response = Shop
````

## GET /api/v1/shopkeepers/:shopkeeperId
````typescript
type Response = Shopkeeper
````

## GET /api/v1/financial-manager/transactions/groups
````typescript
type Response = {
  total: number;
  pendingFromArcus: number;
  closed: number;
}
````

## GET /api/v1/financial-manager/transactions
````typescript

type PageQuery = {
  page: number;
}
type TransactionsQuery = {
  state: TransactionState,
  startDate: Date,
  endDate: Date,
  textSearch: string,
  pov: Date
}

type Query = PageQuery & TransactionsQuery;

type Response = {
  createdAt: Date;
  transactionId: UUID;
  amount: number;
  amountPaidByClient: number;
  shopOwnerCommission: number;
  shopOwnerHasBeenPaid: boolean;
  debtFromArcus: number;
  arcusHasPaidUs: boolean;
  rabbitCommission: number;
  shopOwnerName: string;
  status: TransactionState;
}
````

## GET /api/v1/financial-manager/transactions/overview

````typescript
type OverviewQuery = TransactionsQuery

type Response = {
  arcus: {
    pending: number;
    paid: number;
  };
  shopOwners: {
    pending: number;
    paid: number;
  };
  benefits: number;
}
````

## GET /api/v1/financial-manager/transactions/export
````typescript
type ExportFormatQuery = {
  format: "xlcs" | "pdf"
}
type TransactionsExportQuery = TransactionsQuery & ExportFormatQuery

type Response = {
  arcus: {
    pending: number;
    paid: number;
  };
  shopOwners: {
    pending: number;
    paid: number;
  };
  benefits: number;
}
````

## POST /api/v1/financial-manager/transactions/files/arcus-debts
Excel file with the needed information about closed debts with Arcus

## POST /api/v1/financial-manager/transactions/files/shop-owners-commissions
Uploads an excel file with the needed information about closed commissions with shop owners

## GET /api/v1/financial-manager/transactions/files/shop-owners-commissions
Downloads an excel file with the needed information about pending commissions with shop owners


