API Completa de Faturamento, Faturas, Créditos, Transações e Orçamentos

AcceptQuote

Aceita um orçamento específico.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|--------|------------|--------------------------------|
| action | string | Sim | "AcceptQuote" |
| quoteid | int | Sim | ID do orçamento |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AcceptQuote',
            'quoteid' => '123',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'AcceptQuote';
$postData = array(
    'quoteid' => '123',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "quoteid": 123
}

AddBillableItem

Adiciona item faturável a um cliente.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "AddBillableItem" |
| userid | int | Sim | ID do cliente |
| description | string | Sim | Descrição do item |
| amount | decimal | Sim | Valor do item |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddBillableItem',
            'userid' => '1',
            'description' => 'Serviço adicional',
            'amount' => '50.00',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'AddBillableItem';
$postData = array(
    'userid' => '1',
    'description' => 'Serviço adicional',
    'amount' => '50.00',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "itemid": 456
}

AddCredit

Adiciona crédito à conta do cliente.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "AddCredit" |
| userid | int | Sim | ID do cliente |
| amount | decimal | Sim | Valor do crédito |
| description | string | Não | Descrição do crédito |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddCredit',
            'userid' => '1',
            'amount' => '100.00',
            'description' => 'Crédito inicial',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'AddCredit';
$postData = array(
    'userid' => '1',
    'amount' => '100.00',
    'description' => 'Crédito inicial',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "creditid": 789
}

AddInvoicePayment

Registra pagamento de fatura existente.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "AddInvoicePayment" |
| invoiceid | int | Sim | ID da fatura |
| transid | string | Sim | ID da transação |
| amount | decimal | Sim | Valor pago |
| gateway | string | Não | Gateway de pagamento |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddInvoicePayment',
            'invoiceid' => '101',
            'transid' => 'TX123',
            'amount' => '100.00',
            'gateway' => 'stripe',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'AddInvoicePayment';
$postData = array(
    'invoiceid' => '101',
    'transid' => 'TX123',
    'amount' => '100.00',
    'gateway' => 'stripe',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "invoiceid": 101,
    "amountapplied": "100.00"
}

AddPayMethod

Adiciona método de pagamento a um cliente.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "AddPayMethod" |
| userid | int | Sim | ID do cliente |
| type | string | Sim | Tipo do método (creditcard, bank) |
| gateway | string | Não | Gateway de pagamento associado |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddPayMethod',
            'userid' => '1',
            'type' => 'creditcard',
            'gateway' => 'stripe',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'AddPayMethod';
$postData = array(
    'userid' => '1',
    'type' => 'creditcard',
    'gateway' => 'stripe',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "paymethodid": 555
}

AddTransaction

Registra uma transação financeira para um cliente.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "AddTransaction" |
| userid | int | Sim | ID do cliente |
| description | string | Sim | Descrição da transação |
| amount | decimal | Sim | Valor da transação |
| date | string | Não | Data da transação (YYYY-MM-DD) |
| gateway | string | Não | Gateway utilizado |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'AddTransaction',
            'userid' => '1',
            'description' => 'Pagamento adicional',
            'amount' => '150.00',
            'date' => '2025-11-23',
            'gateway' => 'stripe',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'AddTransaction';
$postData = array(
    'userid' => '1',
    'description' => 'Pagamento adicional',
    'amount' => '150.00',
    'date' => '2025-11-23',
    'gateway' => 'stripe',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "transactionid": 9001
}

ApplyCredit

Aplica crédito do cliente a uma fatura.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "ApplyCredit" |
| userid | int | Sim | ID do cliente |
| invoiceid | int | Sim | ID da fatura |
| amount | decimal | Sim | Valor de crédito a aplicar |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'ApplyCredit',
            'userid' => '1',
            'invoiceid' => '101',
            'amount' => '50.00',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'ApplyCredit';
$postData = array(
    'userid' => '1',
    'invoiceid' => '101',
    'amount' => '50.00',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "appliedamount": "50.00",
    "invoiceid": 101
}

CapturePayment

Captura pagamento de uma fatura pendente através do gateway.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "CapturePayment" |
| invoiceid | int | Sim | ID da fatura |
| amount | decimal | Não | Valor a capturar |
| gateway | string | Sim | Gateway de pagamento |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'CapturePayment',
            'invoiceid' => '101',
            'amount' => '100.00',
            'gateway' => 'stripe',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'CapturePayment';
$postData = array(
    'invoiceid' => '101',
    'amount' => '100.00',
    'gateway' => 'stripe',
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "capturedamount": "100.00",
    "invoiceid": 101
}

CreateInvoice

Cria uma nova fatura para um cliente.

Parâmetros de requisição

| Parâmetro | Tipo | Obrigatório | Descrição |
|----------------|---------|------------|--------------------------------|
| action | string | Sim | "CreateInvoice" |
| userid | int | Sim | ID do cliente |
| date | string | Não | Data da fatura (YYYY-MM-DD) |
| duedate | string | Não | Data de vencimento (YYYY-MM-DD)|
| items | array | Não | Itens da fatura |
| responsetype | string | Não | "json" |

Exemplo Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'CreateInvoice',
            'userid' => '1',
            'date' => '2025-11-23',
            'duedate' => '2025-12-05',
            'items' => json_encode(array(
                array('description'=>'Hospedagem mensal','amount'=>'25.99')
            )),
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Exemplo Request (Local API)

$command = 'CreateInvoice';
$postData = array(
    'userid' => '1',
    'date' => '2025-11-23',
    'duedate' => '2025-12-05',
    'items' => array(
        array('description'=>'Hospedagem mensal','amount'=>'25.99')
    ),
);
$adminUsername = 'ADMIN_USERNAME';
$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Exemplo Response JSON

{
    "result": "success",
    "invoiceid": 110
}