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

/api/cash_accounts

Authorizations

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '{{base_url}}/api/cash_accounts'

200

200

No body

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

/api/cash_accounts/{id}

Authorizations

Path parameters

idstringrequired

TODO

Example: 2

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '{{base_url}}/api/cash_accounts/{id}'

200

200

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

Obter Contas de Caixa por ID

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

/api/cash_accounts

Authorizations

Body

dataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '{{base_url}}/api/cash_accounts' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": {
      "attributes": {
        "name": "Caixa Teste 2"
      },
      "type": "cash_accounts"
    }
  }'

200

200

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

Sucesso

Remover Caixas Associadas

Remover Contas Bancárias

Remover Contas Bancárias

delete

/api/bank_accounts/{bankAccountId}

Authorizations

Path parameters

bankAccountIdstringrequired

Id da conta bancária

Example: 5

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '{{base_url}}/api/bank_accounts/{bankAccountId}'

200

200

{
  "meta": {}
}

Sucesso