Caixa Associada

Obter Todas as Caixas Associadas

De modo a obter informações sobre um dado descritor, poderá realizar o seguinte pedido

Obter Todas as Contas de Caixa

Obter Todas as Contas de Caixa

GET{{base_url}}/api/cash_accounts

Response

200

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/cash_accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Exemplo de Response

{
    "data": [
        {
            "type": "cash_accounts",
            "id": "2",
            "attributes": {
                "name": "Caixa Teste 1"
            },
            "relationships": {
                "company": {
                    "data": {
                        "type": "current_company",
                        "id": "800000046"
                    }
                }
            }
        }
    ]
}

Obter Caixas Associadas por ID

Obter Contas de Caixa por ID

Obter Contas de Caixa por ID

GET{{base_url}}/api/cash_accounts/{id}

Path parameters

id*string

TODO

Example: "2"

Response

200

Obter Contas de Caixa por ID

Headers

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/cash_accounts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "attributes": {
      "name": "Caixa Teste 1"
    },
    "id": "2",
    "relationships": {
      "company": {
        "data": {
          "id": "800000046",
          "type": "current_company"
        }
      }
    },
    "type": "cash_accounts"
  }
}

Endpoint

GET /api/bank_accounts/2

Response

{
    "data": {
        "type": "bank_accounts",
        "id": "2",
        "attributes": {
            "entity_type": "User",
            "description": null,
            "name": "BANCO BPI, SA",
            "nib": "001049282327079673218",
            "swift": "BBPIPTPL",
            "iban": "PT50001049282327079673218",
            "initial_balance": null,
            "sub_type": "ticket_account",
            "card_number": "",
            "account_type": "DO",
            "only_one_payment": null,
            "is_connected": false,
            "consent_until": null
        },
        "relationships": {
            "supplier": {
                "data": null
            },
            "user": {
                "data": {
                    "type": "current_company_users",
                    "id": "800000863"
                }
            }
        }
    }
}

Criar Caixas Associadas

Criar Contas de Caixa

Criar Contas de Caixa

POST{{base_url}}/api/cash_accounts

Body

application/json

dataobject

Response

200

Sucesso

Headers

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/cash_accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "name": "Caixa Teste 2"
        },
        "type": "cash_accounts"
      }
    }),
});
const data = await response.json();

Response

200

{
  "data": {
    "attributes": {
      "name": "Caixa Teste 2"
    },
    "id": "3",
    "relationships": {
      "company": {
        "data": {
          "id": "800000046",
          "type": "current_company"
        }
      }
    },
    "type": "cash_accounts"
  }
}

Remover Caixas Associadas

Remover Contas Bancárias

Remover Contas Bancárias

DELETE{{base_url}}/api/bank_accounts/{bankAccountId}

Path parameters

bankAccountId*string

Id da conta bancária

Example: "5"

Response

200

Sucesso

Headers

Body

application/json

metaobject

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/bank_accounts/{bankAccountId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "meta": {}
}