Sign in
accounting
creditmemo

Update a creditmemo

patch/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

Request body

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

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

Changes

Changed in 3 of the 25 revisions of this API.211

  • 1c744a7590b425See the full diff
    • ●

      added the new SERVICE_CHARGE enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new TIP enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the enum value metadata to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the new SERVICE_CHARGE enum value to the request property ////

      request-property-enum-value-added

    • ○

      added the new TIP enum value to the request property ////

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 963bcc74f9e33See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the enum value applications to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 8f24376685673See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the enum value apply_amount to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added