FeesAndPayouts

Get a list of payouts.

get/api/v1/PaymentFeesAndPayouts/Payouts

Request

  • Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cin7.com/api/v1/PaymentFeesAndPayouts/Payouts
  • Auth: none declared

Query parameters

fieldsstring
wherestring
orderstring
pageinteger
rowsinteger

Response

OK

idinteger

The unique Cin7 Id.

invoiceReferencestring nullable

Payment fee or payout reference, e.g. for fees we use "PMTFEE-{id}" and for payouts we use the Orders_25

descriptionstring nullable

Description

stripePaymentIdstring nullable

Payment Id from stripe

transactionTypestring nullable

Indicates whether the record is a Payment Fee or Payout.

createdDatestring date-time nullable

Created Date in UTC, serialized as ISO 8601 (e.g. 2024-01-15T13:45:30Z).

totalnumber double

Amount of the fee or payout

currencystring nullable

Currency code (e.g. NZD, USD)

accountingTreatmentstring nullable

Predefined DR/CR accounting behavior

taxTreatmentstring nullable

Tax handling

isNetOfSettlementboolean

Indicates whether the amount is net of settlement

Changes

No recorded changes to this operation across all 1 revision of this API.