---
title: "List payments"
method: POST
path: "/billing/payments/list/"
tags: ["Payments (Payments)"]
---

# List payments

`POST /billing/payments/list/`

## Headers

- `Content-Language` unknown

## Request body

- OfficeGuyAppsBillingMVCAPIPaymentsControllerPaymentsListRequest
  - `Credentials` CoreAPICredentials, required
    - `CompanyID` integer, required — Company identifier
    - `APIKey` string, required — API key secret
  - `Date_From` string, date-time, required — Payments date range (from)
  - `Date_To` string, date-time, required — Payments date range (to)
  - `Valid` boolean, nullable — List only valid/invalid payments
  - `StartIndex` integer — Start index for paging

## Response `200`

OK

- ResponseOfficeGuyAppsBillingMVCAPIPaymentsControllerPaymentsListResponse
  - `Status` 'Success (0)' | 'BusinessError (1)' | 'TechnicalError (2)'
  - `UserErrorMessage` string, nullable — Error message, in a user readable format
  - `TechnicalErrorDetails` string, nullable — Technical error details, let us know if you received this.
  - `Data` OfficeGuyAppsBillingMVCAPIPaymentsControllerPaymentsListResponse
    - `Payments` OfficeGuyAppsBillingMVCAPITypedPayment[], nullable
      - `ID` integer — Payment identifier
      - `CustomerID` integer — Customer identifier
      - `Date` string, date-time, nullable — Payment date
      - `ValidPayment` boolean — Indicates if the payment is valid
      - `Status` string, nullable — Payment status
      - `StatusDescription` string, nullable — Payment status description
      - `Amount` number, double — Payment amount
      - `Currency` 'ILS (0)' | 'USD (1)' | 'EUR (2)' | 'CAD (3)' | 'CHF (4)' | 'GBP (5)' | 'AUD (6)' | 'JPY (8)' | 'SEK (9)' | 'NOK (10)' | 'DKK (11)' | 'ZAR (12)' | 'JOD (13)' | 'LBP (14)' | 'EGP (15)' | 'ARS (32)' | 'BSD (44)' | 'BHD (48)' | 'BDT (50)' | 'AMD (51)' | 'BBD (52)' | 'BMD (60)' | 'BTN (64)' | 'BOB (68)' | 'BWP (72)' | 'BZD (84)' | 'SBD (90)' | 'BND (96)' | 'MMK (104)' | 'BIF (108)' | 'KHR (116)' | 'CVE (132)' | 'KYD (136)' | 'LKR (144)' | 'CLP (152)' | 'CNY (156)' | 'COP (170)' | 'KMF (174)' | 'CRC (188)' | 'HRK (191)' | 'CUP (192)' | 'CZK (203)' | 'DOP (214)' | 'SVC (222)' | 'ETB (230)' | 'ERN (232)' | 'FKP (238)' | 'FJD (242)' | 'DJF (262)' | 'GMD (270)' | 'GIP (292)' | 'GTQ (320)' | 'GNF (324)' | 'GYD (328)' | 'HTG (332)' | 'HNL (340)' | 'HKD (344)' | 'HUF (348)' | 'ISK (352)' | 'INR (356)' | 'IDR (360)' | 'IRR (364)' | 'IQD (368)' | 'JMD (388)' | 'KZT (398)' | 'KES (404)' | 'KPW (408)' | 'KRW (410)' | 'KWD (414)' | 'KGS (417)' | 'LAK (418)' | 'LSL (426)' | 'LRD (430)' | 'LYD (434)' | 'MOP (446)' | 'MWK (454)' | 'MYR (458)' | 'MVR (462)' | 'MUR (480)' | 'MXN (484)' | 'MNT (496)' | 'MDL (498)' | 'MAD (504)' | 'OMR (512)' | 'NAD (516)' | 'NPR (524)' | 'ANG (532)' | 'AWG (533)' | 'VUV (548)' | 'NZD (554)' | 'NIO (558)' | 'NGN (566)' | 'PKR (586)' | 'PAB (590)' | 'PGK (598)' | 'PYG (600)' | 'PEN (604)' | 'PHP (608)' | 'QAR (634)' | 'RUB (643)' | 'RWF (646)' | 'SHP (654)' | 'SAR (682)' | 'SCR (690)' | 'SLL (694)' | 'SGD (702)' | 'VND (704)' | 'SOS (706)' | 'SZL (748)' | 'SYP (760)' | 'THB (764)' | 'TOP (776)' | 'TTD (780)' | 'AED (784)' | 'TND (788)' | 'UGX (800)' | 'MKD (807)' | 'TZS (834)' | 'UYU (858)' | 'UZS (860)' | 'WST (882)' | 'YER (886)' | 'TWD (901)' | 'CUC (931)' | 'ZWL (932)' | 'BYN (933)' | 'TMT (934)' | 'GHS (936)' | 'SDG (938)' | 'RSD (941)' | 'MZN (943)' | 'AZN (944)' | 'RON (946)' | 'TRY (949)' | 'XAF (950)' | 'XCD (951)' | 'XOF (952)' | 'XPF (953)' | 'XAU (959)' | 'XDR (960)' | 'XAG (961)' | 'ZMW (967)' | 'SRD (968)' | 'MGA (969)' | 'AFN (971)' | 'TJS (972)' | 'AOA (973)' | 'BGN (975)' | 'CDF (976)' | 'BAM (977)' | 'UAH (980)' | 'GEL (981)' | 'PLN (985)' | 'BRL (986)' | 'CLF (990)'
      - `PaymentMethod` OfficeGuyAppsBillingMVCAPITypedPaymentMethod
        - `ID` integer, nullable
        - `CustomerID` integer, nullable
        - `CreditCard_Number` string, nullable — Credit card full number Required for credit card
        - `CreditCard_LastDigits` string, nullable — Credit card last 4 digits Shouldn't be input by API caller
        - `CreditCard_ExpirationMonth` integer, nullable — Credit card expiration month (1-2 digits) Required for credit card
        - `CreditCard_ExpirationYear` integer, nullable — Credit card expiration year (4 digits) Required for credit card
        - `CreditCard_CVV` string, nullable — Credit card CVV/CVV2 Required when CVV is required by credit company
        - `CreditCard_Track2` string, nullable — Credit card Track2
        - `CreditCard_CitizenID` string, nullable — Credit card owner Israel Citizen ID / Passport Number Required when Citizen ID is required by credit company
        - `CreditCard_CardMask` string, nullable — Credit card mask Shouldn't be input by API caller
        - `CreditCard_Token` string, nullable — Credit card token
        - `DirectDebit_Bank` integer, nullable — Direct debit bank number For instance, 12 indicates Bank Hapoalim.
        - `DirectDebit_Branch` integer, nullable — Direct debit bank branch number
        - `DirectDebit_Account` integer, nullable — Direct debit bank account number
        - `DirectDebit_ExpirationDate` string, date-time, nullable — Direct debit expiration date
        - `DirectDebit_MaximumAmount` integer, nullable — Direct debit maximum charge amount
        - `Type` 'Other (0)' | 'CreditCard (1)' | 'DirectDebit (2)'
      - `AuthNumber` string, nullable — Authorization number
      - `FirstPaymentAmount` number, double, nullable — First credit card installments payment amount
      - `NonFirstPaymentAmount` number, double, nullable — Non first credit card installments payment amount
      - `RecurringCustomerItemIDs` integer[], nullable — Relevant only for payments originating from recurring payments
    - `HasNextPage` boolean

---

[API](https://skmtc.net/myofficeguy/apis/sumit-api-full.md) · [All operations](https://skmtc.net/myofficeguy/apis/sumit-api-full/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myofficeguy/sumit-api-full/versions/de2902289b3a/schema)