# Get incoming payments

Endpoint: GET /api/v3/receivables/{companyId}/{state}
Version: v3
Security: client_credentials, implicit, client_credentials_dev, implicit_dev

## Path parameters:

  - `companyId` (string, required)
    Company Id

  - `state` (integer, required)
    Receivable state filter
    Enum: 0, 1, 2

## Query parameters:

  - `account` (string)
    Account filter (optional)

  - `fromDate` (string)
    Time frame limitation

  - `toDate` (string)
    Time frame limitation

  - `take` (integer)
    Pagination: Max number to return (default 100)

  - `skip` (integer)
    Pagination: Number to skip (default 0)

## Response 200 fields (text/plain):

  - `state` (integer, required)
    InpaymentState
* 0 - Queued
* 1 - Transferred
* 2 - Error
    Enum: 0, 1, 2

  - `receivables` (array, required)
    Transactions

  - `receivables.receivableId` (string)
    Unique reference for receivable

  - `receivables.entryId` (string,null)
    Entry id from account statement

  - `receivables.entryReference` (string,null)
    EntryReference

  - `receivables.accountNumber` (string,null)
    Deposit account

  - `receivables.debtorAccountNumber` (string,null)
    Withdrawal account

  - `receivables.debtorName` (string,null)
    Customer name

  - `receivables.debtorAddress` (string,null)
    Customer address

  - `receivables.archiveReference` (string,null)
    Bank reference

  - `receivables.structuredReference` (string,null)
    KID, FIK, OCR (SCOR reference)

  - `receivables.description` (string,null)
    Unstructured reference (payment message)

  - `receivables.invoiceNumber` (string,null)
    Invoice number

  - `receivables.bookingDate` (string)
    Processed date

  - `receivables.valueDate` (string)
    Exchange date

  - `receivables.amount` (number)
    Payment amount or fee amount

  - `receivables.currency` (string,null)
    Payment or fee currency type

  - `receivables.bookedAmount` (number,null)
    Booked amount

  - `receivables.exchangeRate` (number,null)
    Exchange rate

  - `receivables.accountCurrency` (string,null)
    Currency of bank account;

  - `receivables.chargeAmount` (number,null)
    Charge amount

  - `receivables.chargeCurrency` (string,null)
    Charge Currency

  - `receivables.type` (integer)
    TransactionType
* 0 - Payment
* 1 - Charge
    Enum: 0, 1

  - `receivables.bankTransactionCode` (string,null)
    Bank Transaction Codes Domain, Family and Sub-Familiy, dash separated.

  - `receivables.errorMessage` (string,null)
    Error message, only exists on error state

  - `total` (integer, required)


## Response 400 fields

## Response 401 fields