PUT api/Customer

Editar cliente

Request Information

URI Parameters

None.

Body Parameters

Datos

CustomerModelApi
NameDescriptionTypeAdditional information
CustomerId

Identificador del cliente

 globally unique identifier

None.
GrantorTaxId

RFC de la empresa

 string

Required

Matching regular expression pattern: ^[A-Z&Ñ]{3,4}[0-9]{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])[A-Z0-9]{2}[0-9A]$

Max length: 13

Min length: 12
CustomerTaxId

RFC del cliente

 string

Required

Matching regular expression pattern: ^[A-Z&Ñ]{3,4}[0-9]{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])[A-Z0-9]{2}[0-9A]$

Max length: 13

Min length: 12
BusinessName

Razón social

 string

None.
Name

Nombre

 string

Matching regular expression pattern: ^[a-zñüáéíóúA-ZÑÜÁÉÍÓÚ .,]+$

Max length: 250
Surname1

Primer apellido

 string

Matching regular expression pattern: ^[a-zñüáéíóúA-ZÑÜÁÉÍÓÚ .,]+$

Max length: 50
Surname2

Segundo apellido

 string

Matching regular expression pattern: ^[a-zñüáéíóúA-ZÑÜÁÉÍÓÚ .,]+$

Max length: 50
CustomerTypeId

Tipo de cliente

 integer

Required
CitizenshipId

Nacionalidad

 integer

Required
ContactInfo

Datos de contacto

 ContactInfoModelApi

Required
CustomerContactInfoes

Datos de contacto secundario

 Collection of ContactInfoModelApi

None.
Street

Calle

 string

Max length: 150
ExternalNumber

Número exterior

 string

Max length: 100
InternalNumber

Número interior

 string

Max length: 100
District

Colonia

 string

Max length: 150
ZipCode

Código postal

 string

None.
Municipality

Municipio

 string

None.
State

Estado

 string

None.
Country

Pais

 string

None.
CustomerCode

Código del cliente

 string

Max length: 40
NumRegIdTrib

Número de registro

 string

None.
ResidenceTax

Residencia fiscal

 string

None.
DeliveryPortal

Entrega portal

 DeliveryPortalModelApi

None.
Settings

Propiedades

 CustomerSettingsModelApi

None.
Defaults

Valores por defecto para emisión

 CustomerDefaultsModelApi

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerId": "08dd2a9f-6f02-121f-ba1f-9f255856338d",
  "GrantorTaxId": "sample string 2",
  "CustomerTaxId": "sample string 3",
  "BusinessName": "sample string 4",
  "Name": "sample string 5",
  "Surname1": "sample string 6",
  "Surname2": "sample string 7",
  "CustomerTypeId": 1,
  "CitizenshipId": 1,
  "ContactInfo": {
    "CustomerContactInfoesId": "08dd2a9f-6f02-121f-ba1f-9f255856338e",
    "Email": "sample string 1",
    "Phone": "sample string 2",
    "CellPhone": "sample string 3",
    "PrefixPhone": "sample string 4",
    "PrefixCellphone": "sample string 5",
    "ContactName": "sample string 6",
    "PhoneActive": true,
    "EmailActive": true,
    "CellphoneActive": true,
    "REPNotification": true,
    "NewDocumentNotification": true,
    "CollectiontNotification": true
  },
  "CustomerContactInfoes": [
    {
      "CustomerContactInfoesId": "08dd2a9f-6f02-121f-ba1f-9f255856338e",
      "Email": "sample string 1",
      "Phone": "sample string 2",
      "CellPhone": "sample string 3",
      "PrefixPhone": "sample string 4",
      "PrefixCellphone": "sample string 5",
      "ContactName": "sample string 6",
      "PhoneActive": true,
      "EmailActive": true,
      "CellphoneActive": true,
      "REPNotification": true,
      "NewDocumentNotification": true,
      "CollectiontNotification": true
    },
    {
      "CustomerContactInfoesId": "08dd2a9f-6f02-121f-ba1f-9f255856338e",
      "Email": "sample string 1",
      "Phone": "sample string 2",
      "CellPhone": "sample string 3",
      "PrefixPhone": "sample string 4",
      "PrefixCellphone": "sample string 5",
      "ContactName": "sample string 6",
      "PhoneActive": true,
      "EmailActive": true,
      "CellphoneActive": true,
      "REPNotification": true,
      "NewDocumentNotification": true,
      "CollectiontNotification": true
    }
  ],
  "Street": "sample string 8",
  "ExternalNumber": "sample string 9",
  "InternalNumber": "sample string 10",
  "District": "sample string 11",
  "ZipCode": "sample string 12",
  "Municipality": "sample string 13",
  "State": "sample string 14",
  "Country": "sample string 15",
  "CustomerCode": "sample string 16",
  "NumRegIdTrib": "sample string 17",
  "ResidenceTax": "sample string 18",
  "DeliveryPortal": {
    "DeliveryPortal": true,
    "UrlDeliveryPortal": "sample string 1",
    "UserDeliveryPortal": "sample string 2",
    "PassDeliveryPortal": "sample string 3"
  },
  "Settings": {
    "Collaborative": true,
    "ReceivePayments": true,
    "CollectionAdvance": true,
    "PaymentDates": [
      {
        "CutOffDate": "2025-01-01T14:04:00.7051807-06:00",
        "PaymentDate": "2025-01-01T14:04:00.7051807-06:00"
      },
      {
        "CutOffDate": "2025-01-01T14:04:00.7051807-06:00",
        "PaymentDate": "2025-01-01T14:04:00.7051807-06:00"
      }
    ]
  },
  "Defaults": {
    "SellerId": "08dd2a9f-6f02-121f-ba1f-9f255856338f",
    "PaymentCondition": 1,
    "ContactId": "08dd2a9f-6f02-121f-ba1f-9f2558563390",
    "PaymentWay": "sample string 2",
    "PaymentMethod": "sample string 3",
    "UseCfdi": "sample string 4",
    "UseCfdiv40": "sample string 5",
    "FiscalRegime": "sample string 6",
    "FiscalRegimeV40": "sample string 7",
    "CurrencyId": 1,
    "ExchangeRateTypeId": 1,
    "ExchangeRate": 1.0,
    "Logo": "sample string 8"
  }
}

application/xml, text/xml

Sample: 
<CustomerModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerUuid>08dd2a9f-6f02-121f-ba1f-9f255856338d</CustomerUuid>
  <GrantorTaxId>sample string 2</GrantorTaxId>
  <CustomerTaxId>sample string 3</CustomerTaxId>
  <BusinessName>sample string 4</BusinessName>
  <Name>sample string 5</Name>
  <Surname1>sample string 6</Surname1>
  <Surname2>sample string 7</Surname2>
  <CustomerTypeId>1</CustomerTypeId>
  <CitizenshipId>1</CitizenshipId>
  <ContactInfo>
    <CustomerContactInfoesId>08dd2a9f-6f02-121f-ba1f-9f255856338e</CustomerContactInfoesId>
    <Email>sample string 1</Email>
    <Phone>sample string 2</Phone>
    <Cellphone>sample string 3</Cellphone>
    <PrefixPhone>sample string 4</PrefixPhone>
    <PrefixCellphone>sample string 5</PrefixCellphone>
    <ContactName>sample string 6</ContactName>
    <PhoneActive>true</PhoneActive>
    <EmailActive>true</EmailActive>
    <CellphoneActive>true</CellphoneActive>
    <REPNotification>true</REPNotification>
    <NewDocumentNotification>true</NewDocumentNotification>
    <CollectiontNotification>true</CollectiontNotification>
  </ContactInfo>
  <CustomerContactInfoes>
    <ContactInfoModelApi>
      <CustomerContactInfoesId>08dd2a9f-6f02-121f-ba1f-9f255856338e</CustomerContactInfoesId>
      <Email>sample string 1</Email>
      <Phone>sample string 2</Phone>
      <Cellphone>sample string 3</Cellphone>
      <PrefixPhone>sample string 4</PrefixPhone>
      <PrefixCellphone>sample string 5</PrefixCellphone>
      <ContactName>sample string 6</ContactName>
      <PhoneActive>true</PhoneActive>
      <EmailActive>true</EmailActive>
      <CellphoneActive>true</CellphoneActive>
      <REPNotification>true</REPNotification>
      <NewDocumentNotification>true</NewDocumentNotification>
      <CollectiontNotification>true</CollectiontNotification>
    </ContactInfoModelApi>
    <ContactInfoModelApi>
      <CustomerContactInfoesId>08dd2a9f-6f02-121f-ba1f-9f255856338e</CustomerContactInfoesId>
      <Email>sample string 1</Email>
      <Phone>sample string 2</Phone>
      <Cellphone>sample string 3</Cellphone>
      <PrefixPhone>sample string 4</PrefixPhone>
      <PrefixCellphone>sample string 5</PrefixCellphone>
      <ContactName>sample string 6</ContactName>
      <PhoneActive>true</PhoneActive>
      <EmailActive>true</EmailActive>
      <CellphoneActive>true</CellphoneActive>
      <REPNotification>true</REPNotification>
      <NewDocumentNotification>true</NewDocumentNotification>
      <CollectiontNotification>true</CollectiontNotification>
    </ContactInfoModelApi>
  </CustomerContactInfoes>
  <Street>sample string 8</Street>
  <ExternalNumber>sample string 9</ExternalNumber>
  <InternalNumber>sample string 10</InternalNumber>
  <District>sample string 11</District>
  <ZipCode>sample string 12</ZipCode>
  <Municipality>sample string 13</Municipality>
  <State>sample string 14</State>
  <Country>sample string 15</Country>
  <CustomerCode>sample string 16</CustomerCode>
  <NumRegIdTrib>sample string 17</NumRegIdTrib>
  <ResidenceTax>sample string 18</ResidenceTax>
  <DeliveryPortal>
    <DeliveryPortal>true</DeliveryPortal>
    <UrlDeliveryPortal>sample string 1</UrlDeliveryPortal>
    <UserDeliveryPortal>sample string 2</UserDeliveryPortal>
    <PassDeliveryPortal>sample string 3</PassDeliveryPortal>
  </DeliveryPortal>
  <CustomerSettings>
    <IsCollaborative>true</IsCollaborative>
    <ReceivePayments>true</ReceivePayments>
    <CollectionAdvance>true</CollectionAdvance>
    <Collaborative_Dates>
      <CollaborativeDatesModelApi>
        <CutOffDate>2025-01-01T14:04:00.7051807-06:00</CutOffDate>
        <PaymentDate>2025-01-01T14:04:00.7051807-06:00</PaymentDate>
      </CollaborativeDatesModelApi>
      <CollaborativeDatesModelApi>
        <CutOffDate>2025-01-01T14:04:00.7051807-06:00</CutOffDate>
        <PaymentDate>2025-01-01T14:04:00.7051807-06:00</PaymentDate>
      </CollaborativeDatesModelApi>
    </Collaborative_Dates>
  </CustomerSettings>
  <Defaults>
    <SellerId>08dd2a9f-6f02-121f-ba1f-9f255856338f</SellerId>
    <PaymentCondition>1</PaymentCondition>
    <ContactId>08dd2a9f-6f02-121f-ba1f-9f2558563390</ContactId>
    <PaymentWay>sample string 2</PaymentWay>
    <PaymentMethod>sample string 3</PaymentMethod>
    <UseCfdi>sample string 4</UseCfdi>
    <UseCfdiv40>sample string 5</UseCfdiv40>
    <FiscalRegime>sample string 6</FiscalRegime>
    <FiscalRegimeV40>sample string 7</FiscalRegimeV40>
    <CurrencyId>1</CurrencyId>
    <ExchangeRateTypeId>1</ExchangeRateTypeId>
    <ExchangeRate>1</ExchangeRate>
    <Logo>sample string 8</Logo>
  </Defaults>
</CustomerModelApi>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerModelApi'.

Response Information

Resource Description

ResponseModelApiOfCustomerModelApi
NameDescriptionTypeAdditional information
success

Indica si la solicitud se procesó de manera satisfactoria

 boolean

None.
message

Mensaje de la solicitud

 string

None.
messageDetail

Lista de mensajes

 Collection of string

None.
failureCode

Código de error en caso de existir

 string

None.
data

Layout de respuesta de la solicitud

 CustomerModelApi

None.

Response Formats

application/json, text/json

Sample: 
{
  "success": true,
  "message": "sample string 2",
  "messageDetail": [
    "sample string 1",
    "sample string 2"
  ],
  "failureCode": "sample string 3",
  "data": {
    "CustomerId": "08dd2a9f-6f09-d9cd-ba1f-9f2558563391",
    "GrantorTaxId": "sample string 2",
    "CustomerTaxId": "sample string 3",
    "BusinessName": "sample string 4",
    "Name": "sample string 5",
    "Surname1": "sample string 6",
    "Surname2": "sample string 7",
    "CustomerTypeId": 1,
    "CitizenshipId": 1,
    "ContactInfo": {
      "CustomerContactInfoesId": "08dd2a9f-6f09-d9cd-ba1f-9f2558563392",
      "Email": "sample string 1",
      "Phone": "sample string 2",
      "CellPhone": "sample string 3",
      "PrefixPhone": "sample string 4",
      "PrefixCellphone": "sample string 5",
      "ContactName": "sample string 6",
      "PhoneActive": true,
      "EmailActive": true,
      "CellphoneActive": true,
      "REPNotification": true,
      "NewDocumentNotification": true,
      "CollectiontNotification": true
    },
    "CustomerContactInfoes": [
      {
        "CustomerContactInfoesId": "08dd2a9f-6f09-d9cd-ba1f-9f2558563392",
        "Email": "sample string 1",
        "Phone": "sample string 2",
        "CellPhone": "sample string 3",
        "PrefixPhone": "sample string 4",
        "PrefixCellphone": "sample string 5",
        "ContactName": "sample string 6",
        "PhoneActive": true,
        "EmailActive": true,
        "CellphoneActive": true,
        "REPNotification": true,
        "NewDocumentNotification": true,
        "CollectiontNotification": true
      },
      {
        "CustomerContactInfoesId": "08dd2a9f-6f09-d9cd-ba1f-9f2558563392",
        "Email": "sample string 1",
        "Phone": "sample string 2",
        "CellPhone": "sample string 3",
        "PrefixPhone": "sample string 4",
        "PrefixCellphone": "sample string 5",
        "ContactName": "sample string 6",
        "PhoneActive": true,
        "EmailActive": true,
        "CellphoneActive": true,
        "REPNotification": true,
        "NewDocumentNotification": true,
        "CollectiontNotification": true
      }
    ],
    "Street": "sample string 8",
    "ExternalNumber": "sample string 9",
    "InternalNumber": "sample string 10",
    "District": "sample string 11",
    "ZipCode": "sample string 12",
    "Municipality": "sample string 13",
    "State": "sample string 14",
    "Country": "sample string 15",
    "CustomerCode": "sample string 16",
    "NumRegIdTrib": "sample string 17",
    "ResidenceTax": "sample string 18",
    "DeliveryPortal": {
      "DeliveryPortal": true,
      "UrlDeliveryPortal": "sample string 1",
      "UserDeliveryPortal": "sample string 2",
      "PassDeliveryPortal": "sample string 3"
    },
    "Settings": {
      "Collaborative": true,
      "ReceivePayments": true,
      "CollectionAdvance": true,
      "PaymentDates": [
        {
          "CutOffDate": "2025-01-01T14:04:00.7561677-06:00",
          "PaymentDate": "2025-01-01T14:04:00.7561677-06:00"
        },
        {
          "CutOffDate": "2025-01-01T14:04:00.7561677-06:00",
          "PaymentDate": "2025-01-01T14:04:00.7561677-06:00"
        }
      ]
    },
    "Defaults": {
      "SellerId": "08dd2a9f-6f09-d9cd-ba1f-9f2558563393",
      "PaymentCondition": 1,
      "ContactId": "08dd2a9f-6f09-d9cd-ba1f-9f2558563394",
      "PaymentWay": "sample string 2",
      "PaymentMethod": "sample string 3",
      "UseCfdi": "sample string 4",
      "UseCfdiv40": "sample string 5",
      "FiscalRegime": "sample string 6",
      "FiscalRegimeV40": "sample string 7",
      "CurrencyId": 1,
      "ExchangeRateTypeId": 1,
      "ExchangeRate": 1.0,
      "Logo": "sample string 8"
    }
  }
}

application/xml, text/xml

Sample: 
<ResponseModelApiOfCustomerModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
  <message>sample string 2</message>
  <messageDetail>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </messageDetail>
  <failureCode>sample string 3</failureCode>
  <data>
    <CustomerUuid>08dd2a9f-6f09-d9cd-ba1f-9f2558563391</CustomerUuid>
    <GrantorTaxId>sample string 2</GrantorTaxId>
    <CustomerTaxId>sample string 3</CustomerTaxId>
    <BusinessName>sample string 4</BusinessName>
    <Name>sample string 5</Name>
    <Surname1>sample string 6</Surname1>
    <Surname2>sample string 7</Surname2>
    <CustomerTypeId>1</CustomerTypeId>
    <CitizenshipId>1</CitizenshipId>
    <ContactInfo>
      <CustomerContactInfoesId>08dd2a9f-6f09-d9cd-ba1f-9f2558563392</CustomerContactInfoesId>
      <Email>sample string 1</Email>
      <Phone>sample string 2</Phone>
      <Cellphone>sample string 3</Cellphone>
      <PrefixPhone>sample string 4</PrefixPhone>
      <PrefixCellphone>sample string 5</PrefixCellphone>
      <ContactName>sample string 6</ContactName>
      <PhoneActive>true</PhoneActive>
      <EmailActive>true</EmailActive>
      <CellphoneActive>true</CellphoneActive>
      <REPNotification>true</REPNotification>
      <NewDocumentNotification>true</NewDocumentNotification>
      <CollectiontNotification>true</CollectiontNotification>
    </ContactInfo>
    <CustomerContactInfoes>
      <ContactInfoModelApi>
        <CustomerContactInfoesId>08dd2a9f-6f09-d9cd-ba1f-9f2558563392</CustomerContactInfoesId>
        <Email>sample string 1</Email>
        <Phone>sample string 2</Phone>
        <Cellphone>sample string 3</Cellphone>
        <PrefixPhone>sample string 4</PrefixPhone>
        <PrefixCellphone>sample string 5</PrefixCellphone>
        <ContactName>sample string 6</ContactName>
        <PhoneActive>true</PhoneActive>
        <EmailActive>true</EmailActive>
        <CellphoneActive>true</CellphoneActive>
        <REPNotification>true</REPNotification>
        <NewDocumentNotification>true</NewDocumentNotification>
        <CollectiontNotification>true</CollectiontNotification>
      </ContactInfoModelApi>
      <ContactInfoModelApi>
        <CustomerContactInfoesId>08dd2a9f-6f09-d9cd-ba1f-9f2558563392</CustomerContactInfoesId>
        <Email>sample string 1</Email>
        <Phone>sample string 2</Phone>
        <Cellphone>sample string 3</Cellphone>
        <PrefixPhone>sample string 4</PrefixPhone>
        <PrefixCellphone>sample string 5</PrefixCellphone>
        <ContactName>sample string 6</ContactName>
        <PhoneActive>true</PhoneActive>
        <EmailActive>true</EmailActive>
        <CellphoneActive>true</CellphoneActive>
        <REPNotification>true</REPNotification>
        <NewDocumentNotification>true</NewDocumentNotification>
        <CollectiontNotification>true</CollectiontNotification>
      </ContactInfoModelApi>
    </CustomerContactInfoes>
    <Street>sample string 8</Street>
    <ExternalNumber>sample string 9</ExternalNumber>
    <InternalNumber>sample string 10</InternalNumber>
    <District>sample string 11</District>
    <ZipCode>sample string 12</ZipCode>
    <Municipality>sample string 13</Municipality>
    <State>sample string 14</State>
    <Country>sample string 15</Country>
    <CustomerCode>sample string 16</CustomerCode>
    <NumRegIdTrib>sample string 17</NumRegIdTrib>
    <ResidenceTax>sample string 18</ResidenceTax>
    <DeliveryPortal>
      <DeliveryPortal>true</DeliveryPortal>
      <UrlDeliveryPortal>sample string 1</UrlDeliveryPortal>
      <UserDeliveryPortal>sample string 2</UserDeliveryPortal>
      <PassDeliveryPortal>sample string 3</PassDeliveryPortal>
    </DeliveryPortal>
    <CustomerSettings>
      <IsCollaborative>true</IsCollaborative>
      <ReceivePayments>true</ReceivePayments>
      <CollectionAdvance>true</CollectionAdvance>
      <Collaborative_Dates>
        <CollaborativeDatesModelApi>
          <CutOffDate>2025-01-01T14:04:00.7561677-06:00</CutOffDate>
          <PaymentDate>2025-01-01T14:04:00.7561677-06:00</PaymentDate>
        </CollaborativeDatesModelApi>
        <CollaborativeDatesModelApi>
          <CutOffDate>2025-01-01T14:04:00.7561677-06:00</CutOffDate>
          <PaymentDate>2025-01-01T14:04:00.7561677-06:00</PaymentDate>
        </CollaborativeDatesModelApi>
      </Collaborative_Dates>
    </CustomerSettings>
    <Defaults>
      <SellerId>08dd2a9f-6f09-d9cd-ba1f-9f2558563393</SellerId>
      <PaymentCondition>1</PaymentCondition>
      <ContactId>08dd2a9f-6f09-d9cd-ba1f-9f2558563394</ContactId>
      <PaymentWay>sample string 2</PaymentWay>
      <PaymentMethod>sample string 3</PaymentMethod>
      <UseCfdi>sample string 4</UseCfdi>
      <UseCfdiv40>sample string 5</UseCfdiv40>
      <FiscalRegime>sample string 6</FiscalRegime>
      <FiscalRegimeV40>sample string 7</FiscalRegimeV40>
      <CurrencyId>1</CurrencyId>
      <ExchangeRateTypeId>1</ExchangeRateTypeId>
      <ExchangeRate>1</ExchangeRate>
      <Logo>sample string 8</Logo>
    </Defaults>
  </data>
</ResponseModelApiOfCustomerModelApi>