Empresa

Create a new transaction.

Aceita conta bancária OU cartão de crédito como origem, nunca as duas e nunca nenhuma (Decisão B). Com credit_card_account_id, installments (ausente ou 1 = à vista, teto 24) parcela a compra e payment_date não é aceito — quem é paga é a fatura. Compra cuja competência cai em fatura já paga é realocada para a próxima fatura aberta, sem recusar (RQ-5’); a resposta traz warnings com o aviso. Compra parcelada consome UMA unidade da cota mensal, não N.

POST

companies

transactions

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "amount": 123,
  "bank_account_id": "<string>",
  "coa_id": 123,
  "competence": "2023-12-25",
  "contact": "<string>",
  "cost_center_id": "<string>",
  "credit_card_account_id": "<string>",
  "due_date": "2023-12-25",
  "installments": 123,
  "more_infos": "<string>",
  "payment_date": "2023-12-25",
  "reason": "<string>",
  "reference": "<string>",
  "supplier_id": "<string>",
  "tags": [
    "<string>"
  ],
  "type": "<string>",
  "url": "<string>"
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

payload = {
    "amount": 123,
    "bank_account_id": "<string>",
    "coa_id": 123,
    "competence": "2023-12-25",
    "contact": "<string>",
    "cost_center_id": "<string>",
    "credit_card_account_id": "<string>",
    "due_date": "2023-12-25",
    "installments": 123,
    "more_infos": "<string>",
    "payment_date": "2023-12-25",
    "reason": "<string>",
    "reference": "<string>",
    "supplier_id": "<string>",
    "tags": ["<string>"],
    "type": "<string>",
    "url": "<string>"
}
headers = {
    "x-company-id": "<x-company-id>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-company-id': '<x-company-id>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 123,
    bank_account_id: '<string>',
    coa_id: 123,
    competence: '2023-12-25',
    contact: '<string>',
    cost_center_id: '<string>',
    credit_card_account_id: '<string>',
    due_date: '2023-12-25',
    installments: 123,
    more_infos: '<string>',
    payment_date: '2023-12-25',
    reason: '<string>',
    reference: '<string>',
    supplier_id: '<string>',
    tags: ['<string>'],
    type: '<string>',
    url: '<string>'
  })
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 123,
    'bank_account_id' => '<string>',
    'coa_id' => 123,
    'competence' => '2023-12-25',
    'contact' => '<string>',
    'cost_center_id' => '<string>',
    'credit_card_account_id' => '<string>',
    'due_date' => '2023-12-25',
    'installments' => 123,
    'more_infos' => '<string>',
    'payment_date' => '2023-12-25',
    'reason' => '<string>',
    'reference' => '<string>',
    'supplier_id' => '<string>',
    'tags' => [
        '<string>'
    ],
    'type' => '<string>',
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-company-id: <x-company-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"bank_account_id\": \"<string>\",\n  \"coa_id\": 123,\n  \"competence\": \"2023-12-25\",\n  \"contact\": \"<string>\",\n  \"cost_center_id\": \"<string>\",\n  \"credit_card_account_id\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"installments\": 123,\n  \"more_infos\": \"<string>\",\n  \"payment_date\": \"2023-12-25\",\n  \"reason\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"supplier_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"type\": \"<string>\",\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-company-id", "<x-company-id>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"bank_account_id\": \"<string>\",\n  \"coa_id\": 123,\n  \"competence\": \"2023-12-25\",\n  \"contact\": \"<string>\",\n  \"cost_center_id\": \"<string>\",\n  \"credit_card_account_id\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"installments\": 123,\n  \"more_infos\": \"<string>\",\n  \"payment_date\": \"2023-12-25\",\n  \"reason\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"supplier_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"type\": \"<string>\",\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 123,\n  \"bank_account_id\": \"<string>\",\n  \"coa_id\": 123,\n  \"competence\": \"2023-12-25\",\n  \"contact\": \"<string>\",\n  \"cost_center_id\": \"<string>\",\n  \"credit_card_account_id\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"installments\": 123,\n  \"more_infos\": \"<string>\",\n  \"payment_date\": \"2023-12-25\",\n  \"reason\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"supplier_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"type\": \"<string>\",\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{}

{}

{
  "error": "<string>",
  "message": "<string>"
}

{}

{}

{}

{}

Authorizations

Authorization

string

header

required

Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).

Headers

x-company-id

string

required

company uuid

Body

application/json

Transaction data

amount

number

bank_account_id

string

coa_id

integer

competence

string<date>

contact

string

cost_center_id

string

CostCenterID e BankAccountID seguem string (e não ponteiro): o corpo atual continua válido byte a byte, e ausência de conta deixou de ser erro por si só — passou a depender de haver, ou não, cartão no lugar dela.

credit_card_account_id

string

CreditCardAccountID é a SEGUNDA origem possível (Decisão B). Aditivo: ausente, tudo se comporta exatamente como antes desta feature.

due_date

string<date>

DueDate, Competence e PaymentDate são DateOnly (não time.Time): aceitam "AAAA-MM-DD" (Swagger) e RFC3339 (frontend web) — ver date_only.go.

installments

integer

Installments é PONTEIRO para distinguir "ausente" de "1". Os dois significam à vista, mas só o ponteiro permite recusar installments enviado junto com conta bancária — silenciar levaria o usuário a crer que parcelou algo que não foi parcelado (mesma regra que a coluna Parcelas do CSV tem na spec).

O TETO (24, decisão Q2) NÃO é validado aqui: quem o decide é creditcardrepo.validatePurchaseRequest, via ErrInstallmentsOutOfRange, e duplicar o número neste arquivo criaria duas fontes para o mesmo limite.

more_infos

string

payment_date

string<date>

reason

string

Reason é lido SÓ pelo PUT de lançamento de conta bancária (paid-transaction-reversal / T7): obrigatório quando a edição move dinheiro (valor, conta ou tipo de lançamento pago — RN7), ignorado quando não move. O POST de criação o ignora.

reference

string

supplier_id

string

Response

{id, warnings?: [{code, message, original_reference_month, target_invoice_id, target_reference_month, target_due_date}]} — warnings omitido quando a compra não foi realocada

The response is of type object.

Create a new transaction.

curl --request POST \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <x-company-id>' \
  --data '
{
  "amount": 123,
  "bank_account_id": "<string>",
  "coa_id": 123,
  "competence": "2023-12-25",
  "contact": "<string>",
  "cost_center_id": "<string>",
  "credit_card_account_id": "<string>",
  "due_date": "2023-12-25",
  "installments": 123,
  "more_infos": "<string>",
  "payment_date": "2023-12-25",
  "reason": "<string>",
  "reference": "<string>",
  "supplier_id": "<string>",
  "tags": [
    "<string>"
  ],
  "type": "<string>",
  "url": "<string>"
}
'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

payload = {
    "amount": 123,
    "bank_account_id": "<string>",
    "coa_id": 123,
    "competence": "2023-12-25",
    "contact": "<string>",
    "cost_center_id": "<string>",
    "credit_card_account_id": "<string>",
    "due_date": "2023-12-25",
    "installments": 123,
    "more_infos": "<string>",
    "payment_date": "2023-12-25",
    "reason": "<string>",
    "reference": "<string>",
    "supplier_id": "<string>",
    "tags": ["<string>"],
    "type": "<string>",
    "url": "<string>"
}
headers = {
    "x-company-id": "<x-company-id>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-company-id': '<x-company-id>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 123,
    bank_account_id: '<string>',
    coa_id: 123,
    competence: '2023-12-25',
    contact: '<string>',
    cost_center_id: '<string>',
    credit_card_account_id: '<string>',
    due_date: '2023-12-25',
    installments: 123,
    more_infos: '<string>',
    payment_date: '2023-12-25',
    reason: '<string>',
    reference: '<string>',
    supplier_id: '<string>',
    tags: ['<string>'],
    type: '<string>',
    url: '<string>'
  })
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 123,
    'bank_account_id' => '<string>',
    'coa_id' => 123,
    'competence' => '2023-12-25',
    'contact' => '<string>',
    'cost_center_id' => '<string>',
    'credit_card_account_id' => '<string>',
    'due_date' => '2023-12-25',
    'installments' => 123,
    'more_infos' => '<string>',
    'payment_date' => '2023-12-25',
    'reason' => '<string>',
    'reference' => '<string>',
    'supplier_id' => '<string>',
    'tags' => [
        '<string>'
    ],
    'type' => '<string>',
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "x-company-id: <x-company-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"bank_account_id\": \"<string>\",\n  \"coa_id\": 123,\n  \"competence\": \"2023-12-25\",\n  \"contact\": \"<string>\",\n  \"cost_center_id\": \"<string>\",\n  \"credit_card_account_id\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"installments\": 123,\n  \"more_infos\": \"<string>\",\n  \"payment_date\": \"2023-12-25\",\n  \"reason\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"supplier_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"type\": \"<string>\",\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-company-id", "<x-company-id>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"bank_account_id\": \"<string>\",\n  \"coa_id\": 123,\n  \"competence\": \"2023-12-25\",\n  \"contact\": \"<string>\",\n  \"cost_center_id\": \"<string>\",\n  \"credit_card_account_id\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"installments\": 123,\n  \"more_infos\": \"<string>\",\n  \"payment_date\": \"2023-12-25\",\n  \"reason\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"supplier_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"type\": \"<string>\",\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 123,\n  \"bank_account_id\": \"<string>\",\n  \"coa_id\": 123,\n  \"competence\": \"2023-12-25\",\n  \"contact\": \"<string>\",\n  \"cost_center_id\": \"<string>\",\n  \"credit_card_account_id\": \"<string>\",\n  \"due_date\": \"2023-12-25\",\n  \"installments\": 123,\n  \"more_infos\": \"<string>\",\n  \"payment_date\": \"2023-12-25\",\n  \"reason\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"supplier_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"type\": \"<string>\",\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{}

{}

{
  "error": "<string>",
  "message": "<string>"
}

{}

{}

{}

{}

Começar

Operações

Create a new transaction.

Authorizations

Headers

Body

Response