accounting
vendorcredit

Update a vendorcredit

Changed on
patch/accounting/{connection_id}/vendorcredit/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/accounting/{connection_id}/vendorcredit/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Vendorcredit

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

posted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
balance_amountnumber
account_idstring

(reference to AccountingAccount)

currencystring
contact_idstring

(reference to AccountingContact)

bill_idstring
notesstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
organization_idstring
apply_amountnumber
rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

posted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
balance_amountnumber
account_idstring

(reference to AccountingAccount)

currencystring
contact_idstring

(reference to AccountingContact)

bill_idstring
notesstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
organization_idstring
apply_amountnumber
rawobject

Changes

  • 669f9277e173Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

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

    • info

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

    • info

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

  • 1c744a7590b4Revision changes
    • warning

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

    • warning

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

    • info

      added the new optional request property

    • info

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

    • info

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

    • info

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

    • info

      added the optional property to the response with the status