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

Get billing by Integration Identifier

Sandbox
https://api.sandbox.neofin.services
Sandbox
https://api.sandbox.neofin.services
GET
https://api.sandbox.neofin.services
/billing/integration/{integration_identifier}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.sandbox.neofin.services/billing/integration/your-inner-id-123456' \
--header 'api-key: ' \
--header 'secret-key: '
Response Response Example
200 - Example 1
{
    "customer_mail": "string",
    "fine": "string",
    "digest": "string",
    "status": "string",
    "installments": 0,
    "nfe_number": "string",
    "customer_phone": "string",
    "fees": "string",
    "by_mail": true,
    "installment_type": "string",
    "billing_number": "string",
    "created_by_name": "string",
    "customer_document": "string",
    "discount_before_payment": "string",
    "integration_identifier": "string",
    "due_date": 0,
    "updated_at": 0,
    "by_whatsapp": true,
    "issued_at": 0,
    "amount": 0,
    "description": "string",
    "billing_url": "string",
    "discount_before_payment_due_date": 0,
    "customer_name": "string",
    "type": "string",
    "payments": [
        {
            "installment": "string",
            "payment_number": "string",
            "payment_status": "string"
        }
    ]
}

Request

Path Params
integration_identifier
string 
required
Billing's Integration identifier
Example:
your-inner-id-123456
Header Params
api-key
string 
required
Your Neofin API Key
Example:
{{API_KEY}}
secret-key
string 
required
Your Neofin Secret Key
Example:
{{SECRET_KEY}}

Responses

🟢200Success
application/json
Body
customer_mail
string 
required
fine
string 
required
digest
string 
required
status
string 
required
installments
integer 
required
nfe_number
string 
required
customer_phone
string 
required
fees
string 
required
by_mail
boolean 
required
installment_type
string 
required
billing_number
string 
required
created_by_name
string 
required
customer_document
string 
required
discount_before_payment
string 
required
integration_identifier
string 
required
due_date
integer 
required
updated_at
integer 
required
by_whatsapp
boolean 
required
issued_at
integer 
required
amount
integer 
required
description
string 
required
billing_url
string 
required
discount_before_payment_due_date
integer 
required
customer_name
string 
required
type
string 
required
payments
array [object {3}] 
required
installment
string 
optional
payment_number
string 
optional
payment_status
string 
optional
🟠403Invalid API Keys
🟠404Billing not found
Previous
How to retrieve a single billing
Next
Get billing by Billing Number
Built with