Sign in
Customer Credits

Update CustomerCredit record

Update an existing CustomerCredit record with the provided data. Validates all required fields and business rules.

put/public/v2/customer-credits/{record_number}/

Path parameters

record_numberinteger required

The number attribute of the record.

The number attribute of the record.

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

bill_to_addressstring nullable

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_addressstring nullable

Deprecated: send the structured billing_address / shipping_address instead.

custom_fieldsobject[] nullable
datestring date required
transaction_datestring date nullable
invoice_numberinteger nullable
cash_sale_numberinteger nullable
customer_idinteger nullable
company_idinteger required
currency_iso_4217_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required
memostring
record_status'draft' | 'posted' | 'archived'
contract_idinteger nullable

Response

OK

bill_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

customer_idinteger nullable
customer_namestring nullable
transaction_idsinteger[] required
internal_idinteger required
numberinteger required
invoice_numberinteger nullable required
cash_sale_numberinteger nullable required
datestring date required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring date required

Transaction date (inception date) - the date when the transaction actually occurred

company_idinteger required
company_namestring required
company_currencystring required
currency_iso_4217_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required
exchange_ratestring required
amountstring required

Total transaction amount

used_amountstring required

Amount that was already applied to Invoices through Customer Refunds or Customer Prepayment Applications

remaining_amountstring required

Amount that can be applied to Invoices through Customer Refunds or Customer Prepayment Applications

memostring required
record_status'draft' | 'posted' | 'archived' required
contract_idinteger nullable
contractedboolean
created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

Changes

Changed in 9 of the 14 revisions of this API.2721

  • 48edcb3acb7423See the full diff
    • ●

      removed the optional property has_more_lines from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lines_count from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id update_CustomerCreditV2_record removed and replaced with update_CustomerCredit_record

      api-operation-id-removed

    • ○

      the response property items became required for the status 200

      response-property-became-required

    • ○

      the items response's property default value was removed for the status 200

      response-property-default-value-removed

    This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dcb8297898a219See the full diff
    • ▲

      the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ○

      added GstComponentType TaxFamily to the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed the CESS enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the CGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the GST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the HST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the IGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the QST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the SGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200

      response-property-enum-value-removed

  • f338ec8b3f522See the full diff
    • ●

      added the new monday enum value to the integration_remote_records/items/external_source/anyOf[subschema #1: ExternalIntegrationSourceOut]/integration_type/anyOf[subschema #1: IntegrationProviderType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new monday enum value to the integration_remote_records/items/integration_provider/anyOf[subschema #1: IntegrationProviderSchemaOut]/integration_type/anyOf[subschema #1: IntegrationProviderType]/ response property for the response status 200

      response-property-enum-value-added

  • 34b7cf5b4b6c1See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • 1690a2e6f8e92See the full diff
    • ○

      added the new optional request property items/items/company_id

      new-optional-request-property

    • ○

      added the optional property items/items/company_id to the response with the 200 status

      response-optional-property-added

  • bd3299445a5e1See the full diff
    • ●

      added the new netsuite_rutter enum value to the integration_remote_records/items/external_source/anyOf[subschema #1: ExternalIntegrationSourceOut]/integration_type/anyOf[subschema #2: MigrationProviderType]/ response property for the response status 200

      response-property-enum-value-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 525a590a98f82See the full diff
    • ○

      added the new optional request property items/items/tax/anyOf[subschema #1: ItemTaxData]/tax_metadata

      new-optional-request-property

    • ○

      added the optional property items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_metadata to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 506e6073d19114See the full diff
    • ▲

      the response property items became optional for the status 200

      response-property-became-optional

    • ○

      api operation id update_CustomerCredit_record removed and replaced with update_CustomerCreditV2_record

      api-operation-id-removed

    • ○

      added the optional property has_more_lines to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property lines_count to the response with the 200 status

      response-optional-property-added

    • ○

      the items response's property default value was added for the status 200

      response-property-default-value-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 64136e8e19bb2See the full diff
    • ●

      added the new rippling enum value to the integration_remote_records/items/external_source/anyOf[subschema #1: ExternalIntegrationSourceOut]/integration_type/anyOf[subschema #1: IntegrationProviderType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new rippling enum value to the integration_remote_records/items/integration_provider/anyOf[subschema #1: IntegrationProviderSchemaOut]/integration_type/anyOf[subschema #1: IntegrationProviderType]/ response property for the response status 200

      response-property-enum-value-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog