Skip to main content
POST
/
api
/
v1
/
customer-payments
Crear cobranza de cliente
curl --request POST \
  --url https://api.lapyme.com.ar/api/v1/customer-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "point_of_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_date": "<string>",
  "currency": "PES",
  "total_amount": 4503599627370495,
  "splits": [
    {
      "payment_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 4503599627370495,
      "reference": "<string>",
      "card_brand": "<string>",
      "card_batch_number": "<string>",
      "card_coupon_number": "<string>",
      "card_installment_plan_code": "<string>",
      "notes": "<string>",
      "fee_amount": 4503599627370495,
      "fee_percentage_applied": "<string>",
      "fee_fixed_applied": 4503599627370495,
      "net_amount": 4503599627370495,
      "check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "register_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "safe_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "exchange_rate": 1,
  "settlement_currency": "PES",
  "settlement_total_amount": 4503599627370495,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notes": "<string>",
  "applications": [
    {
      "sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applied_amount": 4503599627370495
    }
  ],
  "journal_line_applications": [
    {
      "journal_line_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applied_amount": 4503599627370495
    }
  ],
  "credit_journal_line_applications": [
    {
      "journal_line_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applied_amount": 4503599627370495
    }
  ],
  "credit_note_applications": [
    {
      "credit_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applied_amount": 4503599627370495
    }
  ],
  "advance_applications": [
    {
      "advance_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applied_amount": 4503599627370495
    }
  ],
  "withholdings": [
    {
      "type": "ganancias",
      "amount": 0,
      "certificate_number": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "province_id": "<string>",
      "regimen": "<string>",
      "rate": 123,
      "calculation_base": 0
    }
  ]
}
'
{
  "request_id": "<string>",
  "data": {
    "customer_payment": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "customer",
      "status": "active",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contact_name": "<string>",
      "payment_number": 0,
      "formatted_payment_number": "<string>",
      "payment_date": "<string>",
      "currency": "PES",
      "total_amount": 0,
      "balance": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_name": "<string>",
      "settlement_currency": "PES",
      "settlement_total_amount": 0,
      "exchange_rate": "<string>",
      "notes": "<string>",
      "splits": [
        {
          "payment_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 0,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_method_name": "<string>",
          "reference": "<string>",
          "card_brand": "<string>",
          "card_batch_number": "<string>",
          "card_coupon_number": "<string>",
          "card_installment_plan_code": "<string>",
          "notes": "<string>",
          "fee_amount": 0,
          "fee_percentage_applied": "<string>",
          "fee_fixed_applied": 0,
          "net_amount": 0,
          "check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "register_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "safe_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "applications": [
        {
          "applied_amount": 0,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "credit_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "advance_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "journal_line_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "formatted_invoice_number": "<string>",
          "credit_formatted_invoice_number": "<string>",
          "advance_formatted_payment_number": "<string>"
        }
      ],
      "credit_applications": [
        {
          "applied_amount": 0,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "credit_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "advance_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "journal_line_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "formatted_invoice_number": "<string>",
          "credit_formatted_invoice_number": "<string>",
          "advance_formatted_payment_number": "<string>"
        }
      ],
      "journal_line_applications": [
        {
          "applied_amount": 0,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "credit_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "advance_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "journal_line_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "formatted_invoice_number": "<string>",
          "credit_formatted_invoice_number": "<string>",
          "advance_formatted_payment_number": "<string>"
        }
      ],
      "advance_applications": [
        {
          "applied_amount": 0,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "credit_sale_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "advance_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "journal_line_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "formatted_invoice_number": "<string>",
          "credit_formatted_invoice_number": "<string>",
          "advance_formatted_payment_number": "<string>"
        }
      ],
      "withholdings": [
        {
          "type": "ganancias",
          "amount": 0,
          "certificate_number": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "province_id": "<string>",
          "regimen": "<string>",
          "rate": 123,
          "calculation_base": 0
        }
      ]
    },
    "idempotent_replay": true
  },
  "warnings": [
    "<unknown>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.lapyme.com.ar/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Incluí tu API key en el header Authorization con el prefijo Bearer.

Headers

​
Idempotency-Key
string
required
Required string length: 1 - 255

Body

application/json
​
customer_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
point_of_sale_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
payment_date
string
required
​
currency
enum<string>
required
Available options:
PES,
DOL
​
total_amount
integer
required
Required range: 0 < x <= 9007199254740991
​
splits
object[]
required
​
exchange_rate
number
Required range: x > 0
​
settlement_currency
enum<string>
Available options:
PES,
DOL
​
settlement_total_amount
integer
Required range: 0 < x <= 9007199254740991
​
session_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
notes
string
Maximum string length: 1000
​
applications
object[]
​
journal_line_applications
object[]
​
credit_journal_line_applications
object[]
​
credit_note_applications
object[]
​
advance_applications
object[]
​
withholdings
object[]

Response

Cobranza creada exitosamente

​
request_id
string
required
​
data
object
required
​
warnings
any[]
required