Getting StartedAPI Reference
API Reference

Executes the Add action for the Customers data object.

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

Adds a new customer record.

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
integer
required

AR Company.

required
1 to 999999

Maximum 6 digits.

provide the value.

string
required
length ≤ 60
string
length ≤ 15

Optional, if omitted This value will be calculated based on Vista defaulting logic with trailing digits incase of non unique results.

string
enum

Temporary Customer. Optional. If not provided, N will be defaulted.

Allowed:
MailingAddress
object

Optional, if omitted each property will be defaulted as noted.

BillingAddress
object

Optional, if omitted each property will be defaulted as noted.

CompanyContact
object

Optional, if omitted each property will be defaulted as noted.

string
length ≤ 1

Options: A-Active, I-Inactive, H-OnHold. Optional. If Omitted, A-Active will be defaulted.

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 based on the Provided ARCo. Optional. If omitted, null will be defaulted.

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. Optional. If omitted, today will be defaulted.

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

Optional. If omitted, 0 will be defaulted.

string
enum

Set to Y to retain Customer Transaction detail during purge operations. Optional. If omitted, N will be defaulted.

Allowed:
string
enum

Optional. If omitted, Y will be defaulted.

Allowed:
string
length ≤ 1

Options: O-Open Item, B-Balance Forward. Optional. If not provided, O-Open Item will be defaulted.

string
length ≤ 1

Options: A-Account, I-Invoice, R-RecType, N-No Finance Charges. I-Invoice is only allowed for StmtType = O-Open. Optional. If omitted, N-No Finance Charges will be defaulted.

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

Finance Charge percent. 0.90 = 90%. 1.0 max value. Optional. If omitted, will be defaulted based on Vista defaulting logic.

string
enum

Exclude Contract Invoices from Finance Charge. Optional. If omitted, N will be defaulted.

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

0.90 = 90%. 1.0 max value. Optional. If omitted, 0 will be defaulted.

string | null
string
enum

Miscellaneous Distributions on Invoice. Optional. If omitted, N will be defaulted.

Allowed:
string
enum

Miscellaneous Distributions on Payment. Optional. If omitted, N will be defaulted.

Allowed:
MaterialSales
object

Optional, if omitted each property will be defaulted as noted.

string | null

[PROTECTED FIELD] Australian Business Number. Should be omitted unless the hq/company_parameters.DefaultCountry = AU. Optional. If omitted null will be defaulted.

string | null

[PROTECTED FIELD] Australian Corporate Number. Should be omitted unless the hq/company_parameters.DefaultCountry = AU Optional. If omitted null will be defaulted.

__custom_fields
object

Add properties to this object for any custom fields you want to set as this record is added to 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