PUT api/Customer/Settings

Request Information

URI Parameters

None.

Body Parameters

PutCustomerSettingModelApi
NameDescriptionTypeAdditional information
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
Settings

Configuración del cliente

 CustomerSettingsModelApi

None.

Request Formats

application/json, text/json

Sample: 
{
  "GrantorTaxId": "sample string 1",
  "CustomerTaxId": "sample string 2",
  "Settings": {
    "Collaborative": true,
    "ReceivePayments": true,
    "CollectionAdvance": true,
    "PaymentDates": [
      {
        "CutOffDate": "2025-11-13T08:52:11.2030919-06:00",
        "PaymentDate": "2025-11-13T08:52:11.2030919-06:00"
      },
      {
        "CutOffDate": "2025-11-13T08:52:11.2030919-06:00",
        "PaymentDate": "2025-11-13T08:52:11.2030919-06:00"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<PutCustomerSettingModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GrantorTaxId>sample string 1</GrantorTaxId>
  <CustomerTaxId>sample string 2</CustomerTaxId>
  <CustomerSettings>
    <IsCollaborative>true</IsCollaborative>
    <ReceivePayments>true</ReceivePayments>
    <CollectionAdvance>true</CollectionAdvance>
    <Collaborative_Dates>
      <CollaborativeDatesModelApi>
        <CutOffDate>2025-11-13T08:52:11.2030919-06:00</CutOffDate>
        <PaymentDate>2025-11-13T08:52:11.2030919-06:00</PaymentDate>
      </CollaborativeDatesModelApi>
      <CollaborativeDatesModelApi>
        <CutOffDate>2025-11-13T08:52:11.2030919-06:00</CutOffDate>
        <PaymentDate>2025-11-13T08:52:11.2030919-06:00</PaymentDate>
      </CollaborativeDatesModelApi>
    </Collaborative_Dates>
  </CustomerSettings>
</PutCustomerSettingModelApi>

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 'PutCustomerSettingModelApi'.

Response Information

Resource Description

ResponseModelApiOfPutCustomerSettingModelApi
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

 PutCustomerSettingModelApi

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": {
    "GrantorTaxId": "sample string 1",
    "CustomerTaxId": "sample string 2",
    "Settings": {
      "Collaborative": true,
      "ReceivePayments": true,
      "CollectionAdvance": true,
      "PaymentDates": [
        {
          "CutOffDate": "2025-11-13T08:52:11.2210953-06:00",
          "PaymentDate": "2025-11-13T08:52:11.2210953-06:00"
        },
        {
          "CutOffDate": "2025-11-13T08:52:11.2210953-06:00",
          "PaymentDate": "2025-11-13T08:52:11.2210953-06:00"
        }
      ]
    }
  }
}

application/xml, text/xml

Sample: 
<ResponseModelApiOfPutCustomerSettingModelApi 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>
    <GrantorTaxId>sample string 1</GrantorTaxId>
    <CustomerTaxId>sample string 2</CustomerTaxId>
    <CustomerSettings>
      <IsCollaborative>true</IsCollaborative>
      <ReceivePayments>true</ReceivePayments>
      <CollectionAdvance>true</CollectionAdvance>
      <Collaborative_Dates>
        <CollaborativeDatesModelApi>
          <CutOffDate>2025-11-13T08:52:11.2210953-06:00</CutOffDate>
          <PaymentDate>2025-11-13T08:52:11.2210953-06:00</PaymentDate>
        </CollaborativeDatesModelApi>
        <CollaborativeDatesModelApi>
          <CutOffDate>2025-11-13T08:52:11.2210953-06:00</CutOffDate>
          <PaymentDate>2025-11-13T08:52:11.2210953-06:00</PaymentDate>
        </CollaborativeDatesModelApi>
      </Collaborative_Dates>
    </CustomerSettings>
  </data>
</ResponseModelApiOfPutCustomerSettingModelApi>