Patch customer

patch https://api-front.upodi.io/Customers/{id}

Path Params

uuid

required

Customer to patch.

Body Params

Values to patch.

AccountNumber

string | null

The unique account number used to identify the customer.

CompanyName

string | null

Fill in company name if the customer is a company.

CompanyVAT

string | null

VAT no. or TAX id of the customer.

FullName

string

length between 0 and 250

Name of customer.

RefKey

string | null

External reference. Only used for integrations. Not visible in the UI.

PrimaryEmail

string | null

CurrencyCode

string

length between 0 and 5

3-letter ISO code for currency.

AutoBill

boolean

Indicates whether system generated invoices should be automatically booked or not.

HomePhone

string | null

The customer home phone number.

BusinessPhone

string | null

The customer business phone number.

MobilePhone

string | null

The customer mobile phone number.

AddressLine1

string | null

The customer address line one.

AddressLine2

string | null

The customer address line two.

City

string | null

The customer address city.

PostalCode

string | null

Customer postal/zip code.

Country

string | null

Customer country.

County

string | null

The customer address county.

State

string | null

The customer address state.

ParentID

uuid | null

Set another customer as parent customer.

BillToParent

boolean

Booked invoices will be billed to a potential parent customer.

CustomerGroupID

uuid | null

Set the customer group for your customer to be belonging to a specific group

Note

string | null

Here you can write internal notes for each customer.

PaymentTerm

int32 | null

The customer default payment term.

CollectiveBilling

boolean | null

Collect invoices for this customer into one.

BusinessUnitID

uuid | null

Set a Business Unit this customer belongs to.

EmailTemplateSetID

uuid | null

Set a specific email template set for the customer. If left empty a default will be used.

OurReferenceID

uuid | null

Set reference ID for a contact which is your reference at the customers' party.

YourReferenceID

uuid | null

Set reference ID for a contact which is your customers' reference at your party.

Headers

X-version

string

required

Responses

Response body

object

uuid

Gets or sets the Id of the key.

CreatedDate

date-time

Gets or sets the date of creation.

ModifiedDate

date-time

Gets or sets the date of last modification.

CreatedBy

uuid

Gets or sets whom created the entity.

ModifiedBy

uuid

Gets or sets whom did the last modification.

AccountNumber

string | null

An account number up to 50 characters. If not specified on creation, one will be assigned.

CompanyName

string | null

A company name for the customer. If left empty the customer is identified via .

CompanyVAT

string | null

VAT or TAX id of the account.

FullName

string

length between 0 and 250

Name of customer.

RefKey

string | null

External reference. Only used for integrations. Not visible in the UI.

PrimaryEmail

string | null

The primary email of the customer.

CurrencyCode

string

length between 0 and 5

3-letter ISO code for currency.

AutoBill

boolean

Indicates whether system generated invoices should be automatically booked or not.

PaymentMethod

uuid | null

Default payment method.

HomePhone

string | null

BusinessPhone

string | null

MobilePhone

string | null

AddressLine1

string | null

AddressLine2

string | null

City

string | null

Gets or sets the address city.

PostalCode

string | null

Country

string | null

County

string | null

State

string | null

Gets or sets the Address State.

ParentID

uuid | null

Gets or sets the parent account.

BillToParent

boolean

Gets or sets if the parent account is the billing account.

Note

string | null

Tenants can write notes for each customer.

PaymentTerm

int32 | null

Represent payment term.

CollectiveBilling

boolean | null

Collect invoices for this customer into one.

BusinessUnitID

uuid | null

Set a Business Unit this customer belongs to.

EmailTemplateSetID

uuid | null

Set a specific email template set for the customer. If left empty a default will be used.

OurReferenceID

uuid | null

Get or set reference ID for our reference to contact

YourReferenceID

uuid | null

Get or set reference ID for your reference to contact

CustomerGroupID

uuid | null

Discount

object

FullName

string | null

Type

int32

Defines the type of discount consumer.

Members:

0 - Customer
1 - Subscription
2 - Subscription charge

1 2

Amount

double

InvoiceText

string | null

ExpiryPeriod

int32

Defines the Discount expire period.
Interval of this period expires DiscountConsumer Upodi.Data.Models.DiscountConsumer.

Members:

100 - DiscountConsumer expires in days.
200 - DiscountConsumer expires in weeks.
300 - DiscountConsumer expires in months.
400 - DiscountConsumer expires in years.

100 200 300 400

ExpiryPeriodInterval

int32 | null

ExpiryDate

date-time | null

CreatedBy

uuid

ModifiedBy

uuid

Source

string | null

uuid

EntityID

uuid

ModifiedDate

date-time

CreatedDate

date-time

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api-front.upodi.io/Customers/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request