Getting StartedAPI Reference
API Reference

Executes the Change action for the Customers data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/ar/2/data/customers/actions/change

Changes an existing AR Customer record, updating only the properties provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The code of the subscriber that you are making this request for.

Body Params

This 'change' action updates the customer record identified by the __key property in a PATCH style only changing the properties you provide. It is important to understand related properties as validation will be performed on the new values you provide in the context of the other values already on the record. You can think of this operation as opening the Vista program, changing the fields that you provide in this action, and saving the record.

integer
required

AR Company.

__key
required

The hq.company_parameters.CustGroup for the provided ARCo must match the CustGroup for the record you are attempting to change.

string
length ≤ 60
string
length ≤ 15
string
enum

Temporary Customer.

Allowed:
MailingAddress
object
BillingAddress
object
CompanyContact
object
string
length ≤ 1

Options: A-Active, I-Inactive, H-OnHold.

integer | null

Key to ar/receivable_types(ARCo, RecType). Receivable Type as found in AR Receivable Types program. Optional. If omitted, ar/company_parameters.RecType will be defaulted.

string | null

Key to hq/payment_terms(PayTerms). Optional. If omitted, null will be defaulted.

string | null

Key to hq/tax_codes(TaxGroup, TaxCode) TaxGroup is pulled form the existing record and cannot be changed. You must provide a TaxCode for the records current TaxGroup.

string | null

Key to ar/distribution_codes(CustGroup, MiscDistCode). CustGroup as configured in hq/company_parameters. Optional. If omitted, null will be defaulted.

date | null

Format: YYYY-MM-DD.

string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
string
enum

Set to Y to retain Customer Transaction detail during purge operations.

Allowed:
string
enum
Allowed:
string
length ≤ 1

Options: O-Open Item, B-Balance Forward.

string
length ≤ 1

Options: A-Account, I-Invoice, R-RecType, N-No Finance Charges. I-Invoice is only allowed for StmtType = O-Open.

string
^[-+]?[0-9]{1,2}(?:.[0-9]{0,4})?$

Finance Charge percent. 0.90 = 90%. 1.0 max value.

string
enum

Exclude Contract Invoices from Finance Charge.

Allowed:
string
^[-+]?[0-9]{1,2}(?:.[0-9]{0,6})?$

0.90 = 90%. 1.0 max value.

string | null
string
enum

Miscellaneous Distributions on Invoice.

Allowed:
string
enum

Miscellaneous Distributions on Payment.

Allowed:
MaterialSales
object
string | null

[PROTECTED FIELD] Australian Business Number. Should only be set if hq/company_parameters.DefaultCountry = AU for the provided ARCo.

string | null

[PROTECTED FIELD] Australian Corporate Number. Should only be set if hq/company_parameters.DefaultCountry = AU for the provided ARCo.

__custom_fields
object

Add properties to this object for any custom fields you want to change as this record is updated in Vista.

Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated about 1 month ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago