Sign in

v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
accounting
creditmemo

Retrieve a creditmemo

get/accounting/{connection_id}/creditmemo/{id}

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Creditmemo

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
due_atstring date-time
paid_atstring date-time
refunded_atstring date-time
cancelled_atstring date-time
posted_atstring date-time
total_amountnumber
paid_amountnumber
refund_amountnumber
tax_amountnumber
discount_amountnumber
balance_amountnumber
creditmemo_numberstring
contact_idstring
invoice_idstring
currencystring
notesstring
refund_reasonstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
urlstring
payment_collection_method'send_invoice' | 'charge_automatically'
sendboolean
organization_idstring
apply_amountnumber
rawobject