Antes de empezar
API para facturación
La API de Affise le proporciona diferentes métodos para trabajar con facturaciones. Por ejemplo, puede obtener información sobre facturas de pago, crear una factura de pago, eliminarla, etc. En este artículo, encontrará ejemplos de las solicitudes API (métodos) más populares para facturaciones con ejemplos cURL y ejemplos de la respuesta.
💰 La función de facturación a través de API solo está disponible para determinados planes. Póngase en contacto con su gestor de cuenta de Affise para obtener la función.
Obtener lista de pagos
Utilice este método para obtener la lista de pagos según sus propiedades, que puede indicar en su solicitud de API.
El método: GET /3.1/payments.
La solicitud para obtener la lista de pagos con el periodo especificado:
https://api-rocketcompany.affise.com/3.1/payments?date_from=2022-08-08&date_to=2022-12-12
Crear factura de pago
Utilice este método para generar la factura por la suma de dinero determinada para el afiliado determinado según sus propiedades, que puede indicar en su solicitud API.
El método: POST /3.1/payments/create-for-affiliate.
La petición cURL para la creación de una factura de pago con las siguientes propiedades:
el ID del afiliado
el importe de la factura de pago
el ID de moneda
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/create-for-affiliate' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'aid=2' \--data-urlencode 'sum=2' \--data-urlencode 'currency=150'
Generar facturas de pago para afiliados
Utilice este método para generar la facturación de un periodo de tiempo determinado según sus propiedades, que puede indicar en su solicitud de API.
El método: POST /3.1/payments/generate.
La petición cURL para la creación de una factura de pago para afiliados con las siguientes propiedades:
la fecha
el ID de afiliado
el ID de afiliado excluido
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/generate' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'date=2022-05-23' \--data-urlencode 'aid=2' \--data-urlencode 'exclude_aids[]=8'
Actualizar factura de pago
Utilice este método para actualizar la factura de pago según sus propiedades, que puede indicar en su solicitud de API.
El método: POST /3.1/payments/{ID}.
La petición cURL para la actualización de la factura de pago con las siguientes propiedades:
la información de la cuenta de pago
el estado Pagado en parte
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2926' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'payment_account=cuenta de pago' \--data-urlencode 'status=3'
Añadir valor de corrección para factura de pago
Utilice este método para añadir un valor de corrección para la factura de pago de acuerdo con sus propiedades, que puede indicar en su solicitud de API.
El método: POST /3.1/payments/{ID}/add-correction.
La solicitud cURL para añadir el valor de corrección con las siguientes propiedades:
el ingreso = 22
el comentario
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/2921/add-correction' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=alcje7al4vd7p27ev26s1gclqm' \--data-urlencode 'revenue=22' \--data-urlencode 'comment=example'
Eliminarvarias facturas de pago
Utilice este método para eliminar varias facturas de pago en función de sus propiedades, que puede indicar en su solicitud de API.
El método: POST /3.1/payments/bulk-delete.
⚠️ Puede eliminar la facturación con cualquier estado, excepto Completo. Si intentas eliminar la facturación con el estado Completo, obtendrás el siguiente error:
La solicitud cURL para varias facturas de pago eliminando con los ids de factura de pago = 2925 y 2924:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.1/payments/bulk-delete' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'ids[0]=2925' \--data-urlencode 'ids[1]=2924'
Editar sistemas de pago
Utilice este método para editar los sistemas de pago de un afiliado según sus propiedades, que puede indicar en su solicitud de API.
El método: POST /3.0/admin/partner/{ID}.
⚠️ La opción de edición sólo está disponible cuando la facturación tiene cualquier estado, excepto Completo.
La solicitud cURL para editar sistemas de pago con ID de sistemas de afiliados = 13, código de moneda = USD y campos avanzados = 1b765:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/partner/2' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'api-key: 5c9f6bbe709c5b331a9630b1fb1db0ed' \--header 'Cookie: PHPSESSID=7e3nrlm566d1vdqdioiaflrhhn' \--data-urlencode 'payment_systems[0][system_id]=13' \--data-urlencode 'payment_systems[0][currency]=USD' \--data-urlencode 'payment_systems[0][fields][4]=1b765'
Póngase en contacto con el equipo de atención al cliente de Affise en relación con todas las preguntas planteadas a través del correo electrónico: [email protected].