accounting
vendorcredit

List all vendorcredits

get/accounting/{connection_id}/vendorcredit

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

contact_idstring

The contact ID to filter by (reference to AccountingContact)

org_idstring

The org ID to filter by (reference to AccountingOrganization)

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
posted_atstring date-time
total_amountnumber
balance_amountnumber
account_idstring
currencystring
contact_idstring
bill_idstring
notesstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
organization_idstring
apply_amountnumber
rawobject

Changes

Changed in 4 of the 34 revisions of this API.29

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 1c744a7590b422See 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 enum value metadata 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

    • ○

      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

    • ○

      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