POST api/Document/FullDocument

Agregar nuevo documento, pagos y documentos relacionados. Será necesario enviar un multipart/form-data. El primero con los datos generales en formato JSON del documento, los siguientes con los archivos correspondientes a los documentos y comprobantes de pago

Request Information

URI Parameters

None.

Body Parameters

FullDocumentModelApi

Name	Description	Type	Additional information
Document	Datos generales del documento	DocumentLoadModelApi	None.
Payments	Pagos del documento	Collection of PaymentModelApi	None.
RelatedDocument	Documentos relacionados	Collection of DocumentLoadModelApi	None.

Request Formats

application/json, text/json

Sample:

{
  "Document": {
    "Fiscal_Address": {
      "City": "sample string 1",
      "ExternalNumber": "sample string 2",
      "InternalNumber": "sample string 3",
      "District": "sample string 4",
      "Municipality": "sample string 5",
      "Street": "sample string 6",
      "State": "sample string 7",
      "ZipCode": "sample string 8",
      "Country": "sample string 9"
    },
    "Customer": {
      "Citizenship": "sample string 1",
      "PersonalCodeNumber": "sample string 2",
      "CustomerTypeId": 3,
      "DeliveryPortal": true,
      "UrlDeliveryPortal": "sample string 4",
      "UserDeliveryPortal": "sample string 5",
      "PassDeliveryPortal": "sample string 6",
      "CustomerCode": "sample string 7",
      "ResidenceTax": "sample string 8",
      "NumRegIdTrib": "sample string 9"
    },
    "CustomerContact": {
      "CustomerContactInfoesId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950c",
      "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
    },
    "PaymentFrequency": 1,
    "InvoiceDocumentTypeId": 1,
    "ReferenceDocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950d",
    "DocumentDocumentRelated": [
      {
        "DocumentRelatedId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950e",
        "Amount": 1.0,
        "RelatedType": "sample string 2"
      },
      {
        "DocumentRelatedId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950e",
        "Amount": 1.0,
        "RelatedType": "sample string 2"
      }
    ],
    "ExpectedPaymentDate": "2025-01-01T13:54:45.0827996-06:00",
    "DueDays": 1,
    "PaymentReferences": [
      {
        "Bank": "sample string 1",
        "AgreementName": "sample string 2",
        "AccountNumber": "sample string 3",
        "AgreementNumber": "sample string 4",
        "Reference": "sample string 5",
        "BarCodeName": "sample string 6"
      },
      {
        "Bank": "sample string 1",
        "AgreementName": "sample string 2",
        "AccountNumber": "sample string 3",
        "AgreementNumber": "sample string 4",
        "Reference": "sample string 5",
        "BarCodeName": "sample string 6"
      }
    ],
    "ExtendedDueDate": "2025-01-01T13:54:45.0827996-06:00",
    "BeginningBalance": 1.0,
    "ExternalStatementAccountURL": "sample string 1",
    "DueDate": "2025-01-01T13:54:45.0827996-06:00",
    "ExternalRecurrenceId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950f",
    "SellerExternalId": "sample string 2",
    "BranchExternalId": "sample string 3",
    "DocumentCategoryCode": "sample string 4",
    "ExchangeRate": 5.0,
    "ExchangeRateTypeId": 1,
    "IsUncollectibleDebt": true,
    "FileName": "sample string 7",
    "IsMigrated": true,
    "Parciality": {
      "ParcialityType": 1,
      "Periodicity": 1,
      "NumberOfParcialities": 1,
      "Parcialities": [
        {
          "Date": "2025-01-01T13:54:45.0827996-06:00",
          "Percentage": 2.0
        },
        {
          "Date": "2025-01-01T13:54:45.0827996-06:00",
          "Percentage": 2.0
        }
      ]
    },
    "GrantorTaxId": "sample string 8",
    "CountryIsoCode": "sample string 9",
    "PersonalTypeId": 1
  },
  "Payments": [
    {
      "DocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca59510",
      "PaymentAmount": 2.0,
      "PaymentMethod": 1,
      "PaymentDate": "2025-01-01T13:54:45.0827996-06:00",
      "Comments": "sample string 4",
      "ExternalPaymentId": "sample string 5",
      "FileName": "sample string 6",
      "XML": "sample string 7",
      "PaymentInfo": {
        "OperationNumber": "sample string 1",
        "TaxIdSourceAccount": "sample string 2",
        "SourceAccount": "sample string 3",
        "TaxIdTargetAccount": "sample string 4",
        "TargetAccount": "sample string 5",
        "PaymentTypeid": "sample string 6",
        "ForeignBankName": "sample string 7",
        "CadPAgo": "sample string 8",
        "CertPago": "sample string 9",
        "SelloPago": "sample string 10",
        "PaymentType": "sample string 11"
      },
      "Metadata": "sample string 8",
      "Documents": [
        {
          "DocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca59511",
          "Amount": 2.0
        },
        {
          "DocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca59511",
          "Amount": 2.0
        }
      ]
    },
    {
      "DocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca59510",
      "PaymentAmount": 2.0,
      "PaymentMethod": 1,
      "PaymentDate": "2025-01-01T13:54:45.0827996-06:00",
      "Comments": "sample string 4",
      "ExternalPaymentId": "sample string 5",
      "FileName": "sample string 6",
      "XML": "sample string 7",
      "PaymentInfo": {
        "OperationNumber": "sample string 1",
        "TaxIdSourceAccount": "sample string 2",
        "SourceAccount": "sample string 3",
        "TaxIdTargetAccount": "sample string 4",
        "TargetAccount": "sample string 5",
        "PaymentTypeid": "sample string 6",
        "ForeignBankName": "sample string 7",
        "CadPAgo": "sample string 8",
        "CertPago": "sample string 9",
        "SelloPago": "sample string 10",
        "PaymentType": "sample string 11"
      },
      "Metadata": "sample string 8",
      "Documents": [
        {
          "DocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca59511",
          "Amount": 2.0
        },
        {
          "DocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca59511",
          "Amount": 2.0
        }
      ]
    }
  ],
  "RelatedDocument": [
    {
      "Fiscal_Address": {
        "City": "sample string 1",
        "ExternalNumber": "sample string 2",
        "InternalNumber": "sample string 3",
        "District": "sample string 4",
        "Municipality": "sample string 5",
        "Street": "sample string 6",
        "State": "sample string 7",
        "ZipCode": "sample string 8",
        "Country": "sample string 9"
      },
      "Customer": {
        "Citizenship": "sample string 1",
        "PersonalCodeNumber": "sample string 2",
        "CustomerTypeId": 3,
        "DeliveryPortal": true,
        "UrlDeliveryPortal": "sample string 4",
        "UserDeliveryPortal": "sample string 5",
        "PassDeliveryPortal": "sample string 6",
        "CustomerCode": "sample string 7",
        "ResidenceTax": "sample string 8",
        "NumRegIdTrib": "sample string 9"
      },
      "CustomerContact": {
        "CustomerContactInfoesId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950c",
        "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
      },
      "PaymentFrequency": 1,
      "InvoiceDocumentTypeId": 1,
      "ReferenceDocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950d",
      "DocumentDocumentRelated": [
        {
          "DocumentRelatedId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950e",
          "Amount": 1.0,
          "RelatedType": "sample string 2"
        },
        {
          "DocumentRelatedId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950e",
          "Amount": 1.0,
          "RelatedType": "sample string 2"
        }
      ],
      "ExpectedPaymentDate": "2025-01-01T13:54:45.0827996-06:00",
      "DueDays": 1,
      "PaymentReferences": [
        {
          "Bank": "sample string 1",
          "AgreementName": "sample string 2",
          "AccountNumber": "sample string 3",
          "AgreementNumber": "sample string 4",
          "Reference": "sample string 5",
          "BarCodeName": "sample string 6"
        },
        {
          "Bank": "sample string 1",
          "AgreementName": "sample string 2",
          "AccountNumber": "sample string 3",
          "AgreementNumber": "sample string 4",
          "Reference": "sample string 5",
          "BarCodeName": "sample string 6"
        }
      ],
      "ExtendedDueDate": "2025-01-01T13:54:45.0827996-06:00",
      "BeginningBalance": 1.0,
      "ExternalStatementAccountURL": "sample string 1",
      "DueDate": "2025-01-01T13:54:45.0827996-06:00",
      "ExternalRecurrenceId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950f",
      "SellerExternalId": "sample string 2",
      "BranchExternalId": "sample string 3",
      "DocumentCategoryCode": "sample string 4",
      "ExchangeRate": 5.0,
      "ExchangeRateTypeId": 1,
      "IsUncollectibleDebt": true,
      "FileName": "sample string 7",
      "IsMigrated": true,
      "Parciality": {
        "ParcialityType": 1,
        "Periodicity": 1,
        "NumberOfParcialities": 1,
        "Parcialities": [
          {
            "Date": "2025-01-01T13:54:45.0827996-06:00",
            "Percentage": 2.0
          },
          {
            "Date": "2025-01-01T13:54:45.0827996-06:00",
            "Percentage": 2.0
          }
        ]
      },
      "GrantorTaxId": "sample string 8",
      "CountryIsoCode": "sample string 9",
      "PersonalTypeId": 1
    },
    {
      "Fiscal_Address": {
        "City": "sample string 1",
        "ExternalNumber": "sample string 2",
        "InternalNumber": "sample string 3",
        "District": "sample string 4",
        "Municipality": "sample string 5",
        "Street": "sample string 6",
        "State": "sample string 7",
        "ZipCode": "sample string 8",
        "Country": "sample string 9"
      },
      "Customer": {
        "Citizenship": "sample string 1",
        "PersonalCodeNumber": "sample string 2",
        "CustomerTypeId": 3,
        "DeliveryPortal": true,
        "UrlDeliveryPortal": "sample string 4",
        "UserDeliveryPortal": "sample string 5",
        "PassDeliveryPortal": "sample string 6",
        "CustomerCode": "sample string 7",
        "ResidenceTax": "sample string 8",
        "NumRegIdTrib": "sample string 9"
      },
      "CustomerContact": {
        "CustomerContactInfoesId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950c",
        "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
      },
      "PaymentFrequency": 1,
      "InvoiceDocumentTypeId": 1,
      "ReferenceDocumentId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950d",
      "DocumentDocumentRelated": [
        {
          "DocumentRelatedId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950e",
          "Amount": 1.0,
          "RelatedType": "sample string 2"
        },
        {
          "DocumentRelatedId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950e",
          "Amount": 1.0,
          "RelatedType": "sample string 2"
        }
      ],
      "ExpectedPaymentDate": "2025-01-01T13:54:45.0827996-06:00",
      "DueDays": 1,
      "PaymentReferences": [
        {
          "Bank": "sample string 1",
          "AgreementName": "sample string 2",
          "AccountNumber": "sample string 3",
          "AgreementNumber": "sample string 4",
          "Reference": "sample string 5",
          "BarCodeName": "sample string 6"
        },
        {
          "Bank": "sample string 1",
          "AgreementName": "sample string 2",
          "AccountNumber": "sample string 3",
          "AgreementNumber": "sample string 4",
          "Reference": "sample string 5",
          "BarCodeName": "sample string 6"
        }
      ],
      "ExtendedDueDate": "2025-01-01T13:54:45.0827996-06:00",
      "BeginningBalance": 1.0,
      "ExternalStatementAccountURL": "sample string 1",
      "DueDate": "2025-01-01T13:54:45.0827996-06:00",
      "ExternalRecurrenceId": "08dd2a9e-23d4-d2dc-522b-6e4baca5950f",
      "SellerExternalId": "sample string 2",
      "BranchExternalId": "sample string 3",
      "DocumentCategoryCode": "sample string 4",
      "ExchangeRate": 5.0,
      "ExchangeRateTypeId": 1,
      "IsUncollectibleDebt": true,
      "FileName": "sample string 7",
      "IsMigrated": true,
      "Parciality": {
        "ParcialityType": 1,
        "Periodicity": 1,
        "NumberOfParcialities": 1,
        "Parcialities": [
          {
            "Date": "2025-01-01T13:54:45.0827996-06:00",
            "Percentage": 2.0
          },
          {
            "Date": "2025-01-01T13:54:45.0827996-06:00",
            "Percentage": 2.0
          }
        ]
      },
      "GrantorTaxId": "sample string 8",
      "CountryIsoCode": "sample string 9",
      "PersonalTypeId": 1
    }
  ]
}

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

Response Information

Resource Description

ResponseModelApiOfBoolean

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	boolean	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": true
}

application/xml, text/xml

Sample:

<ResponseModelApiOfBoolean 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>true</data>
</ResponseModelApiOfBoolean>