Billing

Get settlement applications

Returns the settlement applications for the specified invoice number or payment object.

get/settlements

Request

  • Base URL
    https://api.app.subskribe.com
  • URL
    https://api.app.subskribe.com/settlements
  • Auth
    API key in header X-API-Key

Query parameters

invoiceNumberstring

number of the invoice

paymentIdstring

Id of payment

Response

successful operation

idstring uuid
entityIdstring
customerAccountIdstring
invoiceNumberstring
paymentIdstring
creditMemoNumberstring
applicationType'PAYMENT' | 'VOID_PAYMENT' | 'CREDIT' | 'UNAPPLY_CREDIT'
amountnumber
notestring
appliedOninteger
exchangeRateIdstring
exchangeRatenumber
exchangeRateDateinteger
functionalAmountnumber
createdOninteger
status'ATTEMPTING_PAYMENT_COLLECTION' | 'APPLIED_PAYMENT' | 'FAILED'
negatedSettlementIdstring uuid

Changes

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