API

Crear cobranza de cliente

Changed on

Registra una cobranza de cliente con uno o más métodos de pago, aplicaciones a ventas o cuenta corriente, retenciones y datos de cheque cuando corresponde. Reintentar con la misma Idempotency-Key y los mismos datos devuelve la cobranza original con idempotent_replay en true y no registra otra; reutilizar la clave con datos distintos devuelve 409 IDEMPOTENCY_CONFLICT. Ante un 503, reintentá con la misma clave.

post/api/v1/customer-payments

Request

  • Base URL
    https://api.lapyme.com.ar
  • URL
    https://api.lapyme.com.ar/api/v1/customer-payments
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring required

Request body

customer_idstring uuid required
point_of_sale_idstring uuid required
payment_datestring required
currency'ARS' | 'USD' required
exchange_ratenumber
total_amountinteger required
settlement_currency'ARS' | 'USD'
settlement_total_amountinteger
session_idstring uuid
notesstring

Response

Cobranza creada exitosamente

request_idstring required

Changes

    • breaking

      for the header request parameter Idempotency-Key, the minLength was increased from 0 to 1

    • breaking

      removed the enum value DOL of the request property

    • breaking

      removed the enum value DOL of the request property

    • breaking

      removed the enum value PES of the request property

    • breaking

      removed the enum value PES of the request property

    • breaking

      request property // list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property // list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property // list-of-types was narrowed by removing types null from media type application/json

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the // response's property type changed from no type to string number null for status

    • warning

      for the header request parameter Idempotency-Key, the maxLength was set to 255

    • warning

      the request property's maxLength was set to 1000

    • warning

      the // request property's maxLength was set to 100

    • warning

      the // request property's maxLength was set to 100

    • warning

      the // request property's maxLength was set to 100

    • warning

      the // request property's maxLength was set to 100

    • warning

      the /// request property's maxLength was set to 255

    • warning

      the /// request property's maxLength was set to 20

    • warning

      the // request property's maxLength was set to 500

    • warning

      the // request property's maxLength was set to 255

    • warning

      added the new ARS enum value to the // response property for the response status

    • warning

      added the new USD enum value to the // response property for the response status

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      added the new ARS enum value to the request property

    • info

      added the new ARS enum value to the request property

    • info

      added the new USD enum value to the request property

    • info

      added the new USD enum value to the request property

    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added to the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property anyOf list for the response status

    • info

      removed the DOL enum value from the // response property for the response status

    • info

      removed the PES enum value from the // response property for the response status

    • info

      response property data/customer_payment/advance_applications/items/advance_formatted_payment_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/advance_applications/items/credit_formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/advance_applications/items/formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/applications/items/advance_formatted_payment_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/applications/items/credit_formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/applications/items/formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/contact_name list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/created_by_name list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/credit_applications/items/advance_formatted_payment_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/credit_applications/items/credit_formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/credit_applications/items/formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/formatted_payment_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/journal_line_applications/items/advance_formatted_payment_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/journal_line_applications/items/credit_formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/journal_line_applications/items/formatted_invoice_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/notes list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/splits/items/card_batch_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/splits/items/card_brand list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/splits/items/card_coupon_number list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/splits/items/card_installment_plan_code list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/splits/items/fee_percentage_applied list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/splits/items/notes list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/splits/items/reference list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/withholdings/items/province_id list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/withholdings/items/rate list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/customer_payment/withholdings/items/regimen list-of-types was narrowed by removing types null from media type application/json of response 200