Crear documento de cobro

curl --request POST \
  --url https://api.cobrix.co/api/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency: <x-idempotency>' \
  --data '
{
  "reference": "INV-EXT-1001",
  "provider": "erp_acme",
  "amount": 20.25,
  "name": "Plan mensual de internet"
}
'

const options = {
  method: 'POST',
  headers: {
    'x-idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    reference: 'INV-EXT-1001',
    provider: 'erp_acme',
    amount: 20.25,
    name: 'Plan mensual de internet'
  })
};

fetch('https://api.cobrix.co/api/v1/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cobrix.co/api/v1/invoices"

payload = {
    "reference": "INV-EXT-1001",
    "provider": "erp_acme",
    "amount": 20.25,
    "name": "Plan mensual de internet"
}
headers = {
    "x-idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "amount": 123,
  "provider": "<string>",
  "provider_id": "<string>",
  "reference": "<string>",
  "remarks": "<string>",
  "metadata": {},
  "due_date": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_test": true,
  "partial_payment_config": null,
  "payment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "<string>",
    "currency": "<string>",
    "amount": 123,
    "amount_label": "<string>",
    "title": "<string>",
    "description": "<string>",
    "phone": "<string>",
    "expiration_at": "2023-11-07T05:31:56Z",
    "due_date": "2023-12-25",
    "document_link": "<string>",
    "external_id": "<string>",
    "allows": {
      "accounts": true,
      "cards": true,
      "card_extra": true,
      "realtime": true
    },
    "status": "<string>",
    "is_test": true,
    "created_at": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "payment_link": "<string>",
    "redirect_url": "<string>",
    "provider_id": "<string>",
    "metadata": null,
    "customer": null,
    "method": null,
    "splits": [
      {}
    ],
    "company": null,
    "commission": null
  }
}

POST

invoices

Crear documento de cobro

curl --request POST \
  --url https://api.cobrix.co/api/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency: <x-idempotency>' \
  --data '
{
  "reference": "INV-EXT-1001",
  "provider": "erp_acme",
  "amount": 20.25,
  "name": "Plan mensual de internet"
}
'

const options = {
  method: 'POST',
  headers: {
    'x-idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    reference: 'INV-EXT-1001',
    provider: 'erp_acme',
    amount: 20.25,
    name: 'Plan mensual de internet'
  })
};

fetch('https://api.cobrix.co/api/v1/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cobrix.co/api/v1/invoices"

payload = {
    "reference": "INV-EXT-1001",
    "provider": "erp_acme",
    "amount": 20.25,
    "name": "Plan mensual de internet"
}
headers = {
    "x-idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "amount": 123,
  "provider": "<string>",
  "provider_id": "<string>",
  "reference": "<string>",
  "remarks": "<string>",
  "metadata": {},
  "due_date": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_test": true,
  "partial_payment_config": null,
  "payment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source": "<string>",
    "currency": "<string>",
    "amount": 123,
    "amount_label": "<string>",
    "title": "<string>",
    "description": "<string>",
    "phone": "<string>",
    "expiration_at": "2023-11-07T05:31:56Z",
    "due_date": "2023-12-25",
    "document_link": "<string>",
    "external_id": "<string>",
    "allows": {
      "accounts": true,
      "cards": true,
      "card_extra": true,
      "realtime": true
    },
    "status": "<string>",
    "is_test": true,
    "created_at": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "payment_link": "<string>",
    "redirect_url": "<string>",
    "provider_id": "<string>",
    "metadata": null,
    "customer": null,
    "method": null,
    "splits": [
      {}
    ],
    "company": null,
    "commission": null
  }
}

Authorizations

Authorization

string

header

required

Llave cbx_live con scope de documentos públicos.

Headers

x-idempotency

string

required

Clave estable por creación.

Minimum string length: 1

X-Request-Id

string

Body

application/json

reference

string

required

Required string length: 1 - 255

provider

string

required

Debe coincidir con el source del partner.

Required string length: 1 - 64

amount

number

required

Unidades mayores de la moneda de referencia.

Required range: 0.01 <= x <= 1000000Must be a multiple of 0.01

name

string

required

Required string length: 5 - 100

provider_id

string

Required string length: 1 - 255

description

string

Required string length: 4 - 2000

phone

string

Pattern: ^\+[1-9][0-9]{7,14}$

string<email>

Maximum string length: 200

due_date

string<date> | null

YYYY-MM-DD.

document_url

string<uri>

metadata

object

Response

Documento creado o replay idempotente

string<uuid>

required

name

string

required

description

string | null

required

amount

number

required

provider

string

required

provider_id

string | null

required

reference

string

required

status

enum<string>

required

Available options:

CREATED,

PAID,

CONCILIATED,

PAID_FROM_PROVIDER,

DELETE_FROM_PROVIDER,

FAILED

remarks

string | null

required

metadata

object | null

required

due_date

string<date> | null

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

payment_id

string<uuid> | null

required

is_test

boolean

required

partial_payment_config

null

required

Siempre null; esta API exige pago completo.

payment

object | null

required

Show child attributes

Consultar documento de cobro Actualizar documento de cobro