Contas de Recebíveis (Sale Account)

Atributos

 - provider                     | string  | Provedor (consultar listas abaixo)
                                            Campo obrigatório
                                            - bank_account (Conta Bancária)
                                            - cash_register (Caixa Registradora)
                                            - cielo
                                            - getnet
                                            - pagseguro
                                            - redecard
                                            - safrapay
                                            - stone
                                            - ticket
                                            - vero
                                            - other
 - payment_methods              | string  | Lista de métodos de pagamentos que a conta irá aceitar.
                                            Separar com vírgulas e sem espaço entre eles.
                                            Campo obrigatório.
                                            - billet (Boleto Bancário)
                                            - cash (Dinheiro)
                                            - cheque (Cheque)
                                            - credit (Crédito)
                                            - parcelled (Crédito Parcelado)
                                            - debit (Débito)
                                            - transfer (Transferência Bancária)
 - name                         | string  | Nome da conta de recebível
                                            Campo obrigatório
 - description                  | string  | Descrição de conta de recebível
 - entity_id                    | integer | Identificador da entidade qual a conta de recebível pertence
                                            Campo obrigatório

 - consolidate                  | boolean | Consolidar recebíveis
                                            true - Consolidar significa agrupar todos os recebíveis de uma determinada Conta de Recebível em uma só Conta a Receber por Data de Liquidação
                                            false - Não consolidar significa uma Conta a Receber por Recebível

 Os classificadores abaixo serão aplicados nas Contas a Receber geradas a partir dos recebíveis.
 - category_id                  | integer | Identificador da categoria associada à conta de recebível.
 - person_id                    | integer | Identificador do cliente/fornecedor associado à conta de recebível.
 - classification_center_id     | integer | Identificador do centro de custo/receita associado à conta de recebível.
 - custom_classifications       | array   | Array de classificadores personalizados.
                                            Deve ser passado o nome do classificador personalizado e seu valor.

Listar contas de recebíveis

GET /sale_accounts

Exibe os atributos da conta de recebível especificada, retornando 200 Ok.

Exemplo de Resposta

HTTP/1.1 200 OK
Date: Mon, 17 Jan 2011 20:00:02 GMT
Content-Type: application/json; charset=utf-8
[
  {
    "sale_account": {
      "id": 3,
      "entity_id": 1,
      "name": "Conta da Cielo",
      "description": "Conta de recebíveis realizados pela Cielo",
      "provider": "cielo",
      "payment_methods": "credit,debit,parcelled",
      "category_id": 5131,
      "person_id": 25,
      "classification_center_id": null,
      "created_at": "2017-03-06T18:24:43-03:00",
      "updated_at": "2017-04-18T10:34:52-03:00",
      "custom_classifications": [
        {
          "id": 1,
          "custom_classifier_id": 1,
          "custom_classifier_name": "Produto",
          "value": "Cobrato", # DEPRECATED
          "name": "Cobrato",
          "amount": 36.0,
          "percentage": 100.0
        }
      ],
      "classification_center_classifications":[
        {
          id: "1",
          classification_center_id: 1,
          name: "Cobrato",
          percentage: "100.0",
          amount: "36.0"
        }
      ],
      "consolidate": false
    }
  }
]
HTTP/1.1 200 OK
Date: Mon, 17 Jan 2011 20:00:02 GMT
Content-Type: application/xml; charset=utf-8
<sale-accounts type="array">
  <sale-account>
    <custom-classifications type="array">
      <custom-classification>
        <id type="integer">1</id>
        <custom-classifier-id type="integer">1</custom-classifier-id>
        <custom-classifier-name>Região</custom-classifier-name>
        <value>Cobrato</value> # DEPRECATED
        <name>Cobrato</name>
        <percentage type="decimal">100.0</percentage>
        <amount type="decimal">36.0</amount>
      </custom-classification>
    </custom-classifications>
    <classification-center-classifications type="array">
      <classification-center-classification>
        <id type="integer">1</id>
        <classification-center-id type="integer">1</classification-center-id>
        <name>Cobrato</name>
        <percentage type="decimal">100.0</percentage>
        <amount type="decimal">36.0</amount>
      </classification-center-classification>
    </classification-center-classifications>
    <id type="integer">37</id>
    <entity-id type="integer">1</entity-id>
    <name>Maquininha Elo</name>
    <description></description>
    <provider>elo</provider>
    <payment-methods>debit,credit,parcelled</payment-methods>
    <category-id type="integer" nil="true"/>
    <person-id type="integer" nil="true"/>
    <classification-center-id type="integer" nil="true"/>
    <consolidate type="boolean">true</consolidate>
    <created-at type="datetime">2017-06-05T19:43:43-03:00</created-at>
    <updated-at type="datetime">2017-06-05T19:59:58-03:00</updated-at>
  </sale-account>
</sale-accounts>

Exibir uma conta de recebível

GET /sale_accounts/:id

Exibe os atributos da conta de recebível especificada retornando 200 Ok.

Exemplo de Resposta

HTTP/1.1 200 OK
Date: Mon, 17 Jan 2011 20:29:57 GMT
Content-Type: application/json; charset=utf-8
Location: https://app.myfinance.com.br/sale_accounts/37
{
  "sale_account": {
    "id": 37,
    "entity_id": 1,
    "name": "Maquininha Cielo",
    "description": "",
    "provider": "cielo",
    "payment_methods": "debit,credit,parcelled",
    "category_id": null,
    "person_id": null,
    "classification_center_id": null,
    "created_at": "2017-06-05T19:43:43-03:00",
    "updated_at": "2017-06-05T19:59:58-03:00",
    "custom_classifications": [
      {
        "id": 3,
        "custom_classifier_id": 1,
        "custom_classifier_name": "Produto",
        "value": "Cobrato", # DEPRECATED
        "name": "Cobrato",
        "amount": 36.0,
        "percentage": 100.0
      }
    ],
    "classification_center_classifications":[
      {
        id: "3",
        classification_center_id: 1,
        name: "Cobrato",
        percentage: "100.0",
        amount: "36.0"
      }
    ],
    "consolidate": false
  }
}
HTTP/1.1 200 OK
Date: Mon, 17 Jan 2011 20:29:57 GMT
Content-Type: application/xml; charset=utf-8
Location: https://app.myfinance.com.br/sale_accounts/37
<?xml version="1.0" encoding="UTF-8"?>
<sale-account>
  <id type="integer">37</id>
  <entity-id type="integer">1</entity-id>
  <name>Maquininha Elo</name>
  <description></description>
  <provider>elo</provider>
  <payment-methods>debit,credit,parcelled</payment-methods>
  <category-id nil="true"/>
  <person-id nil="true"/>
  <classification-center-id nil="true"/>
  <created-at type="datetime">2017-06-05T19:43:43-03:00</created-at>
  <updated-at type="datetime">2017-06-05T19:59:58-03:00</updated-at>
  <custom-classifications type="array">
    <custom-classification>
      <id type="integer">1</id>
      <custom-classifier-id type="integer">1</custom-classifier-id>
      <custom-classifier-name>Região</custom-classifier-name>
      <value>Cobrato</value> # DEPRECATED
      <name>Cobrato</name>
      <percentage type="decimal">100.0</percentage>
      <amount type="decimal">36.0</amount>
    </custom-classification>
  </custom-classifications>
  <classification-center-classifications type="array">
    <classification-center-classification>
      <id type="integer">1</id>
      <classification-center-id type="integer">1</classification-center-id>
      <name>Cobrato</name>
      <percentage type="decimal">100.0</percentage>
      <amount type="decimal">36.0</amount>
    </classification-center-classification>
  </classification-center-classifications>
  <consolidate type="boolean">true</consolidate>
</sale-account>

Criar conta de recebível

POST /sale_accounts

Cria uma nova conta de recebível do tipo especificado.

HTTP/1.1 201 Created
Date: Mon, 17 Jan 2011 20:29:57 GMT
Content-Type: application/json; charset=utf-8
{
  "sale_account": {
    "description": "Conta de recebíveis realizados pela Cielo",
    "entity_id": 1,
    "name": "Conta da Cielo",
    "provider": "cielo",
    "payment_methods": "credit,debit,parcelled",
    "category_name": "Recebíveis",
    "person_id": 1,
    "custom_classifications": [
      {
        "custom_classifier_id": 1,
        "name": "Zona Sul",
        "amount": 139.9
      }
    ],
    "classification_center_classifications":[
      {
        classification_center_id: 1,
        name: "Zona Sul",
        amount: "139.9"
      }
    ],
    "consolidate": false
  }
}
HTTP/1.1 201 Created
Date: Mon, 17 Jan 2011 20:29:57 GMT
Content-Type: application/xml; charset=utf-8
<sale-account>
  <description>Conta de recebíveis realizadas pela Cielo</description>
  <entity-id type="integer">1</entity-id>
  <name>Conta da Cielo</name>
  <provider>cielo</provider>
  <payment-methods>credit,debit,parcelled</payment-methods>
  <category-name>Recebíveis</category-name>
  <custom-classifications type="array">
    <custom-classification>
      <custom-classifier-id>1</custom-classifier-id>
      <name>Zona Sul</name>
      <amount type="decimal">36.0</amount>
    </custom-classification>
  </custom-classifications>
  <classification-center-classifications type="array">
    <classification-center-classification>
      <classification-center-id type="integer">1</classification-center-id>
      <name>Zona Sul</name>
      <amount type="decimal">36.0</amount>
    </classification-center-classification>
  </classification-center-classifications>
  <consolidate type="boolean">true</consolidate>
</sale-account>

Alterar uma conta de recebível

PUT /sale_accounts/:id

Altera os dados da conta de recebível especificada. Retorna uma resposta vazia com status 200 OK.

Em caso de erro, retorna os erros que impediram de alterar o recurso.

Exemplo de Requisição

{
  "sale_account": {
    "description": "Conta de recebíveis realizadas pela Cielo",
    "id": 3,
    "name": "Conta da Cielo",
    "provider": "cielo",
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<sale-account>
  <description>Conta de recebíveis realizadas pela Cielo</description>
  <id type="integer">3</id>
  <name>Conta da Cielo</name>
  <provider>cielo</provider>
</sale-account>

Apagar uma conta de recebível

Exemplo de Requisição

DELETE /sale_accounts/:id

Esse endpoint somente agenda a destruição da Conta de Recebível. O processo é feito assincronamente e pode demorar, dependendo do número de objetos associados.