Neofin V1
english
  • latest
  • english
  1. Retrieve a billing
Neofin V1
english
  • latest
  • english
  • Start your Neofin journey
  • Setup your environment
  • NeofinV1
    • Billing API
      • Upsert a billing
        • How to upsert a billing
        • Upsert a billing
          POST
      • Retrieve a billing
        • How to retrieve a single billing
        • Get billing by Integration Identifier
          GET
        • Get billing by Billing Number
          GET
      • Mark a billing as paid
        • How to mark a billing as paid
        • Mark a billing as paid
          PUT
      • Cancel a billing
        • How to cancel a billing
        • Cancel a billing
          PUT
      • Listing billings
        • How to list your billings
        • Billing by status
          GET
        • Billing by customer
          GET
        • Billing updated date
          GET
        • Billing Events
          GET
        • Billing Events by Integration Identifier
          GET
      • Upload attachments
        • How to upload attachments
        • Upload a Billing NF by Integration Identifier
          PUT
        • Upload a Billing Boleto by Integration Identifier
          PUT
    • Customer API
      • Upserting a customer
        • How to upsert a customer
        • Upsert a customer
          POST
      • Retrieve a customer
        • Get a customer by Integration Identifier
          GET
        • Get a customer by their document
          GET
    • Webhooks
      • How to setup your webhooks
  1. Retrieve a billing

How to retrieve a single billing

Get invoice by Billing Number#

This endpoint should be used to retrieve the desired invoice information.
cURL example:
ccurl --location 'https://api.sandbox.neofin.services/billing/122087378560242' \
  --header 'api-key: key' \
  --header 'secret-key: secret'
The variables returned within the invoice object may vary according to the "type" of the invoice. Example:
{
   "customer_mail":"teste@neofin.com.br",
   "fine":"",
   "status":"pending",
   "installments":1.0,
   "nfe_number":"000000021",
   "customer_phone":"+5533999751491",
   "fees":"",
   "by_mail":true,
   "installment_type":"custom",
   "billing_number":"122087378560242",
   "created_by_name":"Integração API",
   "customer_document":"24540707078",
   "discount_before_payment":"0",
   "integration_identifier":"Neofin-00000002241",
   "due_date":1703114722.0,
   "updated_at":1703084752.0,
   "by_whatsapp":false,
   "issued_at":1703084752.0,
   "amount":20000.0,
   "description":"Cobrança 000000021 Parcela 1 TESTE",
   "billing_url":"https://sandbox.neofin.com.br/pay?billing=122087378560242",
   "discount_before_payment_due_date":0.0,
   "customer_name":"Empresa teste LTDA",
   "type":"generic"
}

Get invoice by Integration Identifier#

This endpoint should be used to retrieve the desired invoice information.
cURL example:
ccurl --location 'https://api.sandbox.neofin.services/billing/integration/your-integration-identifier-123' \
  --header 'api-key: key' \
  --header 'secret-key: secret'
The variables returned within the invoice object may vary according to the "type" of the invoice. Example:
{
   "customer_mail":"teste@neofin.com.br",
   "fine":"",
   "status":"pending",
   "installments":1.0,
   "nfe_number":"000000021",
   "customer_phone":"+5533999751491",
   "fees":"",
   "by_mail":true,
   "installment_type":"custom",
   "billing_number":"122087378560242",
   "created_by_name":"Integração API",
   "customer_document":"24540707078",
   "discount_before_payment":"0",
   "integration_identifier":"Neofin-00000002241",
   "due_date":1703114722.0,
   "updated_at":1703084752.0,
   "by_whatsapp":false,
   "issued_at":1703084752.0,
   "amount":20000.0,
   "description":"Cobrança 000000021 Parcela 1 TESTE",
   "billing_url":"https://sandbox.neofin.com.br/pay?billing=122087378560242",
   "discount_before_payment_due_date":0.0,
   "customer_name":"Empresa teste LTDA",
   "type":"generic"
}
Previous
Upsert a billing
Next
Get billing by Integration Identifier
Built with