COcodatio
Direct incomes

List direct incomes

Changed on

The List direct incomes endpoint returns a list of direct incomes for a given company's connection.

Direct incomes are incomes received directly from the business' operations at the point of the sale.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/connections/{connectionId}/data/directIncomes

Request

  • Base URL
    https://api.codat.io
  • Auth
    API key in header Authorization

Query parameters

pageinteger
Example:1

Page number. Read more.

pageSizeinteger
Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring
Example:-modifiedDate

Field to order results by. Read more.

Response

Success

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required(unresolved $ref)

Example response

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 1,
  "_links": {
    "self": {
      "href": "/companies/{id}/data/{dataType}"
    },
    "current": {
      "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
    }
  }
}

Changes

  • 4bfab0afa6caRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0fcc5f736d86Revision changes
    • info

      removed the accountTransactions enum value from the ///// response property for the response status

    • info

      removed the balanceSheet enum value from the ///// response property for the response status

    • info

      removed the bankAccounts enum value from the ///// response property for the response status

    • info

      removed the bankTransactions enum value from the ///// response property for the response status

    • info

      removed the banking-accountBalances enum value from the ///// response property for the response status

    • info

      removed the banking-accounts enum value from the ///// response property for the response status

    • info

      removed the banking-transactionCategories enum value from the ///// response property for the response status

    • info

      removed the banking-transactions enum value from the ///// response property for the response status

    • info

      removed the billCreditNotes enum value from the ///// response property for the response status

    • info

      removed the billPayments enum value from the ///// response property for the response status

    • info

      removed the bills enum value from the ///// response property for the response status

    • info

      removed the cashFlowStatement enum value from the ///// response property for the response status

    • info

      removed the chartOfAccounts enum value from the ///// response property for the response status

    • info

      removed the commerce-companyInfo enum value from the ///// response property for the response status

    • info

      removed the commerce-customers enum value from the ///// response property for the response status

    • info

      removed the commerce-disputes enum value from the ///// response property for the response status

    • info

      removed the commerce-locations enum value from the ///// response property for the response status

    • info

      removed the commerce-orders enum value from the ///// response property for the response status

    • info

      removed the commerce-paymentMethods enum value from the ///// response property for the response status

    • info

      removed the commerce-payments enum value from the ///// response property for the response status

    • info

      removed the commerce-productCategories enum value from the ///// response property for the response status

    • info

      removed the commerce-products enum value from the ///// response property for the response status

    • info

      removed the commerce-taxComponents enum value from the ///// response property for the response status

    • info

      removed the commerce-transactions enum value from the ///// response property for the response status

    • info

      removed the company enum value from the ///// response property for the response status

    • info

      removed the creditNotes enum value from the ///// response property for the response status

    • info

      removed the directCosts enum value from the ///// response property for the response status

    • info

      removed the directIncomes enum value from the ///// response property for the response status

    • info

      removed the invoices enum value from the ///// response property for the response status

    • info

      removed the itemReceipts enum value from the ///// response property for the response status

    • info

      removed the items enum value from the ///// response property for the response status

    • info

      removed the journalEntries enum value from the ///// response property for the response status

    • info

      removed the journals enum value from the ///// response property for the response status

    • info

      removed the paymentMethods enum value from the ///// response property for the response status

    • info

      removed the payments enum value from the ///// response property for the response status

    • info

      removed the profitAndLoss enum value from the ///// response property for the response status

    • info

      removed the purchaseOrders enum value from the ///// response property for the response status

    • info

      removed the salesOrders enum value from the ///// response property for the response status

    • info

      removed the taxRates enum value from the ///// response property for the response status

    • info

      removed the trackingCategories enum value from the ///// response property for the response status

    • info

      removed the transfers enum value from the ///// response property for the response status