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

get

Obter Todas as Contas de Caixa

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

200Success

No content

get

/api/cash_accounts

HTTPcURLJavaScriptPython

GET /api/cash_accounts HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200Success

No content

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

get

Obter Contas de Caixa por ID

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

idstringRequired

TODO

Example: 2

Responses

200

Obter Contas de Caixa por ID

application/json

get

/api/cash_accounts/{id}

HTTPcURLJavaScriptPython

GET /api/cash_accounts/{id} HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Obter Contas de Caixa por ID

{
  "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

Criar Caixas Associadas

Criar Contas de Caixa

post

Criar Contas de Caixa

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Body

application/json

Responses

200

Sucesso

application/json

post

/api/cash_accounts

HTTPcURLJavaScriptPython

POST /api/cash_accounts HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "data": {
    "attributes": {
      "name": "Caixa Teste 2"
    },
    "type": "cash_accounts"
  }
}

200

Sucesso

{
  "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

delete

Remover Contas Bancárias

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

bankAccountIdstringRequired

Id da conta bancária

Example: 5

Responses

200

Sucesso

application/json

delete

/api/bank_accounts/{bankAccountId}

HTTPcURLJavaScriptPython

DELETE /api/bank_accounts/{bankAccountId} HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Sucesso

{
  "meta": {}
}