POST api/CollectionPolicy

Guardar politica de cobranza de la empresa

Request Information

URI Parameters

None.

Body Parameters

Datos

Name	Description	Type	Additional information
GrantorTaxId	RFC del grantor	string	Required
IsAfiliatedCC	Afiliado al SIC	boolean	None.
DaysUncollectibleDebt	Dias a partir de cual se puede marcar un documento incobrable	integer	Required Matching regular expression pattern: ^[0-9]*$ Range: inclusive between 1 and 120
IsCreditRateEnabled	Activar notificaciones al SIC	boolean	Required
IsCreditRateAutomatic	Notificación al SIC automática	boolean	None.
DefaultNotificationSchemaId	Plantilla de notificación de cobranza	globally unique identifier	Required
NotificationSchemaList	Lista de plantillas de notificaciones	Collection of NotificationSchemaModelApi	None.
NotificationTypeId	Tipo de notificacion	integer	Required
CollectionReminderTime	Horario para inicio de recordatorios de cobranza - rango válido: (06:00 am - 12:00 pm), ej. (09:59)	string	Max length: 5
ShowDocumentDetail	El cliente puede ver el detalle de la factura	boolean	Required
ArMailName	Nombre usado en los recordatorios de cobranza	string	Required Max length: 100
Email	Correo usado en los recordatorios de cobranza	string	Required Matching regular expression pattern: ^((?:[\w-]+\.)\w[\w-]{0,63})@((?:[\w-]+\.)\w[\w-]{0,98})\.([a-zA-Z]{2,15}(?:\.[a-zA-Z]{2})?)$ Max length: 100
FlagPaymentNotification	Recibir notificaciones de pagos de mis clientes	boolean	Required
MinimumInterest	Interés anual minimo	decimal number	Required Matching regular expression pattern: ^\d+(\.\d{1,2})?$ Range: inclusive between 0 and 100
MaximunInterest	Interés anual máximo	decimal number	Required Matching regular expression pattern: ^\d+(\.\d{1,2})?$ Range: inclusive between 0 and 100
MaximumTermDays	Plazo máximo en días	integer	Required Matching regular expression pattern: ^[0-9]*$ Range: inclusive between 0 and 180
AssignSeller	Asignar vendedor a cada documento	boolean	Required
AssignBranch	Asignar sucursal a cada documento	boolean	Required
UserId	Usuario default vendedor	globally unique identifier	None.
FlagAttachment	Enviar documentos como archivos adjuntos	boolean	Required
ShowLinkDocumentAttachment	El cliente puede ver los documentos relacionados	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "GrantorTaxId": "sample string 1",
  "IsAfiliatedCC": true,
  "DaysUncollectibleDebt": 1,
  "IsCreditRateEnabled": true,
  "IsCreditRateAutomatic": true,
  "DefaultNotificationSchemaId": "08de22c4-0ad9-82b3-ba1f-9f35ac4f117a",
  "NotificationSchemaList": [
    {
      "NotificationSchemaId": "08de22c4-0ad9-82b3-ba1f-9f35ac4f117b",
      "NotificationSchemaName": "sample string 2"
    },
    {
      "NotificationSchemaId": "08de22c4-0ad9-82b3-ba1f-9f35ac4f117b",
      "NotificationSchemaName": "sample string 2"
    }
  ],
  "NotificationTypeId": 1,
  "CollectionReminderTime": "sample string 3",
  "ShowDocumentDetail": true,
  "ArMailName": "sample string 4",
  "Email": "sample string 5",
  "FlagPaymentNotification": true,
  "MinimumInterest": 6.1,
  "MaximunInterest": 7.1,
  "MaximumTermDays": 8,
  "AssignSeller": true,
  "AssignBranch": true,
  "UserId": "08de22c4-0ad9-82b3-ba1f-9f35ac4f117c",
  "FlagAttachment": true,
  "ShowLinkDocumentAttachment": true
}

application/xml, text/xml

Sample:

<GrantorSettingsModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GrantorTaxId>sample string 1</GrantorTaxId>
  <IsAfiliatedCC>true</IsAfiliatedCC>
  <DaysUncollectibleDebt>1</DaysUncollectibleDebt>
  <IsCreditRateEnabled>true</IsCreditRateEnabled>
  <IsCreditRateAutomatic>true</IsCreditRateAutomatic>
  <DefaultNotificationSchemaId>08de22c4-0ad9-82b3-ba1f-9f35ac4f117a</DefaultNotificationSchemaId>
  <NotificationSchemaList>
    <NotificationSchemaModelApi>
      <NotificationSchemaId>08de22c4-0ad9-82b3-ba1f-9f35ac4f117b</NotificationSchemaId>
      <NotificationSchemaName>sample string 2</NotificationSchemaName>
    </NotificationSchemaModelApi>
    <NotificationSchemaModelApi>
      <NotificationSchemaId>08de22c4-0ad9-82b3-ba1f-9f35ac4f117b</NotificationSchemaId>
      <NotificationSchemaName>sample string 2</NotificationSchemaName>
    </NotificationSchemaModelApi>
  </NotificationSchemaList>
  <NotificationTypeId>1</NotificationTypeId>
  <CollectionReminderTime>sample string 3</CollectionReminderTime>
  <ShowDocumentDetail>true</ShowDocumentDetail>
  <ArMailName>sample string 4</ArMailName>
  <Email>sample string 5</Email>
  <FlagPaymentNotification>true</FlagPaymentNotification>
  <MinimumInterest>6.1</MinimumInterest>
  <MaximunInterest>7.1</MaximunInterest>
  <MaximumTermDays>8</MaximumTermDays>
  <AssignSeller>true</AssignSeller>
  <AssignBranch>true</AssignBranch>
  <UserId>08de22c4-0ad9-82b3-ba1f-9f35ac4f117c</UserId>
  <FlagAttachment>true</FlagAttachment>
  <ShowLinkDocumentAttachment>true</ShowLinkDocumentAttachment>
</GrantorSettingsModelApi>

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

Response Information

Resource Description

ResponseModelApiOfGrantorSettingsModelApi

Name	Description	Type	Additional 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	GrantorSettingsModelApi	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",
    "IsAfiliatedCC": true,
    "DaysUncollectibleDebt": 1,
    "IsCreditRateEnabled": true,
    "IsCreditRateAutomatic": true,
    "DefaultNotificationSchemaId": "08de22c4-0adb-e564-ba1f-9f35ac4f117d",
    "NotificationSchemaList": [
      {
        "NotificationSchemaId": "08de22c4-0adb-e564-ba1f-9f35ac4f117e",
        "NotificationSchemaName": "sample string 2"
      },
      {
        "NotificationSchemaId": "08de22c4-0adb-e564-ba1f-9f35ac4f117e",
        "NotificationSchemaName": "sample string 2"
      }
    ],
    "NotificationTypeId": 1,
    "CollectionReminderTime": "sample string 3",
    "ShowDocumentDetail": true,
    "ArMailName": "sample string 4",
    "Email": "sample string 5",
    "FlagPaymentNotification": true,
    "MinimumInterest": 6.1,
    "MaximunInterest": 7.1,
    "MaximumTermDays": 8,
    "AssignSeller": true,
    "AssignBranch": true,
    "UserId": "08de22c4-0adb-e564-ba1f-9f35ac4f117f",
    "FlagAttachment": true,
    "ShowLinkDocumentAttachment": true
  }
}

application/xml, text/xml

Sample:

<ResponseModelApiOfGrantorSettingsModelApi 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>
    <IsAfiliatedCC>true</IsAfiliatedCC>
    <DaysUncollectibleDebt>1</DaysUncollectibleDebt>
    <IsCreditRateEnabled>true</IsCreditRateEnabled>
    <IsCreditRateAutomatic>true</IsCreditRateAutomatic>
    <DefaultNotificationSchemaId>08de22c4-0adb-e564-ba1f-9f35ac4f117d</DefaultNotificationSchemaId>
    <NotificationSchemaList>
      <NotificationSchemaModelApi>
        <NotificationSchemaId>08de22c4-0adb-e564-ba1f-9f35ac4f117e</NotificationSchemaId>
        <NotificationSchemaName>sample string 2</NotificationSchemaName>
      </NotificationSchemaModelApi>
      <NotificationSchemaModelApi>
        <NotificationSchemaId>08de22c4-0adb-e564-ba1f-9f35ac4f117e</NotificationSchemaId>
        <NotificationSchemaName>sample string 2</NotificationSchemaName>
      </NotificationSchemaModelApi>
    </NotificationSchemaList>
    <NotificationTypeId>1</NotificationTypeId>
    <CollectionReminderTime>sample string 3</CollectionReminderTime>
    <ShowDocumentDetail>true</ShowDocumentDetail>
    <ArMailName>sample string 4</ArMailName>
    <Email>sample string 5</Email>
    <FlagPaymentNotification>true</FlagPaymentNotification>
    <MinimumInterest>6.1</MinimumInterest>
    <MaximunInterest>7.1</MaximunInterest>
    <MaximumTermDays>8</MaximumTermDays>
    <AssignSeller>true</AssignSeller>
    <AssignBranch>true</AssignBranch>
    <UserId>08de22c4-0adb-e564-ba1f-9f35ac4f117f</UserId>
    <FlagAttachment>true</FlagAttachment>
    <ShowLinkDocumentAttachment>true</ShowLinkDocumentAttachment>
  </data>
</ResponseModelApiOfGrantorSettingsModelApi>