Documentação
Seja bem vindo a nossa documentação!
Criamos esse conteúdo com bastante zelo para que você consiga aprender tudo que é necessário para utilizar Billimatic.
O Billimatic possui uma API REST para interagir com seus recursos, através de JSON sobre HTTP, usando todos principais verbos HTTP (GET, POST, PATCH, DELETE).
Cada recurso possui sua própria URL e pode ser manipulado de maneira isolada, tentando assim seguir os princípios REST ao máximo ;)
Informações básicas
Autenticação
Todo acesso à API é feito do ponto de vista de uma conta existente no Billimatic. Assim sendo, toda requisição à API deverá ser autenticada.
A autenticação é feita via token, que deve ser informado no header de cada requisição efetuada.
Exemplo:
“Authorization”: “Token token=3d12813150rd61l126216n17605zs1q4”
“Content-Type”: “application/json”
Veja o exemplo abaixo em como fazer sua autenticação ;)
Exemplo de requisição para autenticação
GET http://app.billimatic.com.br/api/v1/organizations \
-H 'authorization: Token token=3d12813150rd61l126216n17605zs1q4' \
-H 'content-type: application/json'
Exemplo do retorno
{
"chave": "valor"
}
Http Status
Em todas as requisições efetuadas pela API Billimatic, havera o retorno do código Http, conforme a tabela abaixo:
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Payloads
Billimatic envia webhooks para notificar diversos eventos ocorridos na aplicação.
Teste
Payload: --
Entidade: --
Evento: Quando uma URL é cadastrada e antes de todo envio de payload para teste de disponibilidade da URL cadastrada
POST
Exemplo de Corpo
{
"test":true
}
Update
Payload: update
Entidade: Invoice
Evento: Quando o faturamento é atualizado
POST
Exemplo de Corpo
{
"event": "update",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Emit
Payload: emit
Entidade: Invoice
Evento: Quando o faturamento é marcado como faturado
POST
Exemplo de Corpo
{
"event": "emit",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Undo_emission
Payload: undo_emission
Entidade: Invoice
Evento: Quando o faturamento é marcado como a faturar
POST
Exemplo de Corpo
{
"event": "undo_emission",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Cancel
Payload: cancel
Entidade: Invoice
Evento: Quando o faturamento é cancelado
POST
Exemplo de Corpo
{
"event": "cancel",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Undo_cancellation
Payload: undo_cancellation
Entidade: Invoice
Evento: Quando é desfeito o cancelamento do faturamento
POST
Exemplo de Corpo
{
"event": "undo_cancellation",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Confirm_receival
Payload: confirm_receival
Entidade: Invoice
Evento: Quando é confirmado o recebimento do faturamento
POST
Exemplo de Corpo
{
"event": "confirm_receival",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Undo_receival
Payload: undo_receival
Entidade: Invoice
Evento: Quando é desfeito o recebimento do faturamento
POST
Exemplo de Corpo
{
"event": "undo_receival",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Receivement_error
Payload: receivement_error
Entidade: Invoice
Evento: Quando há erro no recebimento do faturamento (pagamento em cartão de crédito)
POST
Exemplo de Corpo
{
"event": "receivement_error",
"object_type": "Invoice",
"object_id": "id-da-entidade",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Change_plan
Payload: change_plan
Entidade: Contract
Evento: Quando é solicitada a troca de plano de uma assinatura (e-commerce)
POST
Exemplo de Corpo
{
"event":"change_plan",
"plan_id":"id-do-novo-plano",
"contract_token":"token-do-contrato"
}
Organizações
Cria Organização
Cria nova organização
POST
api/v1/organizations
Exemplo de Corpo
{
"organization": {
"name": "Mattos Bills",
"company_name": "Mattos Bills Ltda",
"cnpj": "57.757.975/0001-86",
"address": "Nossa Senhora das Graças",
"number": "390",
"complement": "-",
"zipcode": "02460100",
"district": "Centro",
"city": "São Paulo",
"state": "SP"
}
}
Exemplo do retorno
{
"organization": {
"id": 14008,
"account_id": 29,
"name": "Mattos Bills",
"company_name": "Mattos Bills Ltda",
"cnpj": "57.757.975/0001-86",
"address": "Nossa Senhora das Graças",
"number": "390",
"complement": "-",
"zipcode": "02460100",
"district": "Centro",
"city": "São Paulo",
"state": "SP",
"created_at": "03/12/2018 11:39:15 -02:00"
}
}
Campos
| Campo | Finalidade |
|---|---|
| name (string) | Nome Fantasia |
| company_name (string, optional) | Razão Social |
| cnpj (string) | CNPJ |
| address (string, optional) | Endereço |
| number (string, optional) | Número |
| complement (string, optional) | Complemento |
| district (string, optional) | Bairro |
| zipcode (string, optional) | CEP |
| city (string, optional) | Cidade |
| state (string, optional) | Estado |
Busca Organização
Realiza busca de uma organização pelo cnpj
GET
api/v1/organizations/search?cnpj=57757975000186
Onde o cnpj=57757975000186 deverá conter o número do cnpj desejado da busca
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"organization": {
"id": 2115,
"account_id": 29,
"name": "Org Doc Bills",
"company_name": "Org Doc Bills",
"cnpj": "57.757.975/0001-86",
"address": "Nossa Senhora das Graças",
"number": "390",
"complement": "-",
"zipcode": "02460100",
"district": "Centro",
"city": "São Paulo",
"state": "SP",
"created_at": "05/12/2018 16:54:00 -02:00"
}
}
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Atualiza Organização
Atualiza uma organização
PATCH
api/v1/organizations/{id}
O corpo deverá conter somente os campos que deseja ser atualizados, tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"organization": {
"name": "Lnz Bills",
"cnpj": "57.757.975/0001-86",
"address": "Nossa Senhora das Graças"
}
}
Exemplo do retorno
{
"organization": {
"id": 14008,
"account_id": 29,
"name": "Lnz Bills",
"company_name": "Mattos Bills Ltda",
"cnpj": "57.757.975/0001-86",
"address": "Nossa Senhora das Graças",
"number": "390",
"complement": "-",
"zipcode": "02460100",
"district": "Centro",
"city": "São Paulo",
"state": "SP",
"created_at": "03/12/2018 11:39:15 -02:00"
}
}
Exclui Organização
Exclui uma organização
DELETE
api/v1/organizations/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
Empresas
Cria Empresa
Cria uma nova empresa
POST
api/v1/companies
Exemplo de Corpo
{
"company": {
"name": "JSkank Company Bills",
"cnpj": "38.624.936/0001-66"
}
}
Exemplo do retorno
{
"company": {
"id": 14009,
"account_id": 29,
"name": "JSkank Company Bills",
"company_name": null,
"cnpj": "38.624.936/0001-66",
"state_inscription": null,
"city_inscription": null,
"address": null,
"number": null,
"zipcode": null,
"district": null,
"complement": null,
"city": null,
"state": null,
"contacts": null,
"billing_contacts": null,
"kind": "company",
"comments": null,
"client_since": null,
"myfinance_customer_id": null,
"myfinance_errors": null,
"created_at": "03/12/2018 12:35:54 -02:00"
}
}
Campos node Product
| Campo | Finalidade |
|---|---|
| name (string) | Nome Fantasia |
| company_name (string, optional) | Razão Social |
| cnpj (string) | CNPJ |
| state_inscription (string, optional) | Inscrição Estadual |
| city_inscription (string, optional) | Inscrição Municipal |
| address (string, optional) | Endereço |
| number (string, optional) | Número |
| complement (string, optional) | Complemento |
| district (string, optional) | Bairro |
| zipcode (string, optional) | CEP |
| city (string, optional) | Cidade |
| state (string, optional) | Estado |
| contacts (string, optional) | Contatos |
| billing_contacts (string, optional) | E-mails para faturamento |
| comments (string, optional) | Observações |
| client_since (date, optional) | Cliente Desde |
Busca Empresa
Realiza busca de empresa pelo número de cnpj
GET
api/v1/companies/search?cnpj=55391268000193
Onde o cnpj=55391268000193 deverá conter o número do cnpj desejado
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"companies": [
{
"id": 2122,
"account_id": 29,
"name": "F1 Teste Documentação",
"company_name": "F1 Teste Documentação Ltda",
"cnpj": "55.391.268/0001-93",
"state_inscription": "",
"city_inscription": "",
"address": "Rua Tiradentes",
"number": "1899",
"zipcode": "09781220",
"district": "Ferrazópolis",
"complement": "",
"city": "São Bernardo do Campo",
"state": "SP",
"contacts": "teste",
"billing_contacts": "teste@teste.com.br",
"kind": "company",
"comments": "teste",
"client_since": null,
"myfinance_customer_id": 213341,
"myfinance_errors": null,
"created_at": "10/12/2018 15:26:12 -02:00"
}
]
}
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Lista Empresa(s)
Lista a(s) empresa(s) em uma conta
GET
api/v1/companies
Exemplo de Corpo
{
"Essa requisição não possui corpo"
}
Exemplo do retorno
{
"companies": [
{
"id": 7828,
"account_id": 29,
"name": "ABC Tech",
"company_name": "ABC Tech",
"cnpj": "63.120.541/0002-59",
"state_inscription": "",
"city_inscription": "",
"address": "Rua Alferes Poli",
"number": "1982",
"zipcode": "80220050",
"district": "Rebouças",
"complement": "",
"city": "Curitiba",
"state": "PR",
"contacts": "ROCHINHA",
"billing_contacts": "abctech@email.com",
"kind": "company",
"comments": "#Empresa Contrato vip nº 20093",
"client_since": null,
"myfinance_customer_id": 2240155,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00"
},
{
"id": 7854,
"account_id": 29,
"name": "Cafe Camanducaia",
"company_name": "Cafe Camanducaia",
"cnpj": "77.152.918/0002-31",
"state_inscription": "",
"city_inscription": "",
"address": "rua afonso delambert neto",
"number": "637",
"zipcode": "88062000",
"district": "lagoa da conceiçao ",
"complement": "",
"city": "Florianópolis",
"state": "SC",
"contacts": "",
"billing_contacts": "cafecamanducaia@email.com.br",
"kind": "company",
"comments": "#Empresa Contrato vip nº 20322",
"client_since": null,
"myfinance_customer_id": 2306837,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00"
},
{
"id": 7853,
"account_id": 29,
"name": "Date Limit Enterprise",
"company_name": "Date Limit Enterprise",
"cnpj": "32.215.246/0001-97",
"state_inscription": "",
"city_inscription": "",
"address": "Rua Novo Horizonte",
"number": "100",
"zipcode": "80220050",
"district": "Rebouças",
"complement": "",
"city": "Curitiba",
"state": "PR",
"contacts": "Rochinha Praia de Leste ",
"billing_contacts": "teste@email.com",
"kind": "company",
"comments": "",
"client_since": null,
"myfinance_customer_id": 2245885,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00"
}
]
}
Detalhes Empresa
Mostra os detalhes de uma empresa
GET
GET api/v1/companies/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"company": {
"id": 7828,
"account_id": 29,
"name": "Gol de Placa",
"company_name": "Gol de Placa",
"cnpj": "31.710.541/0002-59",
"state_inscription": "",
"city_inscription": "",
"address": "Rua Alfredo Gusmoes",
"number": "1982",
"zipcode": "80220050",
"district": "Rebouças",
"complement": "",
"city": "Curitiba",
"state": "PR",
"contacts": "ROCHINHA",
"billing_contacts": "goldeplaca@email.com.br",
"kind": "company",
"comments": "#PINGOID20093",
"client_since": null,
"myfinance_customer_id": 2240155,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00"
}
}
Atualiza Empresa
Atualiza uma empresa
PATCH
api/v1/companies/{id}
O corpo da requisição deverá conter somente o(s) campo(s) que deseja(m) ser atualizado(s), tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"address": "Nossa Senhora das Vitórias",
}
Exemplo do retorno
{
"company": {
"id": 14009,
"account_id": 29,
"name": "JSkank Company Bills",
"company_name": null,
"cnpj": "38.624.936/0001-66",
"state_inscription": null,
"city_inscription": null,
"address": "Av Nossa Senhora das Vitorias",
"number": null,
"zipcode": null,
"district": null,
"complement": null,
"city": null,
"state": null,
"contacts": null,
"billing_contacts": null,
"kind": "company",
"comments": null,
"client_since": null,
"myfinance_customer_id": 2411787,
"myfinance_errors": null,
"created_at": "03/12/2018 12:35:54 -02:00"
}
}
Exclui Empresa
Exclui uma empresa
DELETE
api/v1/companies/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
Pessoas
Cria Pessoa
Cria uma nova pessoa.
POST
api/v1/people
Exemplo de Corpo
{
"name": "Fulano de Tal",
"cpf": "82868688977",
"email": "fulano@email.com",
"zipcode": "02360100",
"address": "Rua Americanas",
"number": "12",
"complement": "",
"district": "Santana",
"city": "São Paulo",
"state": "SP",
"comments": "",
"client_since": "date"
}
Exemplo do retorno
{
"person": {
"id": 1543,
"account_id": 29,
"name": "Fulano de Tal",
"cpf": "82868688977",
"email": "fulano@email.com",
"zipcode": "02360100",
"address": "Rua Americanas",
"number": "12",
"complement": "",
"district": "Santana",
"city": "São Paulo",
"state": "SP",
"comments": "",
"client_since": null,
"myfinance_customer_id": null,
"myfinance_errors": null,
"created_at": "05/12/2018 14:03:36 -02:00"
}
}
Campos
| Campo | Finalidade |
|---|---|
| name (string) | Nome |
| cpf (string) | CPF |
| email (string, optional) | |
| zipcode (string, optional) | CEP |
| address (string, optional) | Endereço |
| number (string, optional) | Número |
| complement (string, optional) | Complemento |
| district (string, optional) | Bairro |
| city (string, optional) | Cidade |
| state (string, optional) | Estado |
| comments (string, optional) | Observações |
| client_since (date, optional) | Cliente Desde |
Busca Pessoa
Realiza busca de uma pessoa pelo seu cpf
GET
api/v1/people/search?cpf=82868688977
Onde cpf=82868688977 será o número do cpf que deseja efetuar a busca.
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"people": [
{
"id": 1543,
"account_id": 29,
"name": "Fulano de Tal",
"cpf": "82868688977",
"email": "fulano@email.com",
"zipcode": "02360100",
"address": "Rua Americanas",
"number": "12",
"complement": "",
"district": "Santana",
"city": "São Paulo",
"state": "SP",
"comments": "",
"client_since": null,
"myfinance_customer_id": 2416551,
"myfinance_errors": null,
"created_at": "05/12/2018 14:03:36 -02:00"
}
]
}
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Lista Pessoa(s)
Lista a(s) pessoa(s) em uma conta
GET
api/v1/people
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"people": [
{
"id": 145,
"account_id": 29,
"name": "Carlos Ferreira",
"cpf": "65641413941",
"email": "cfrira@gmail.com",
"zipcode": "77470000",
"address": "Av. Vitorino Leite",
"number": "Qd. D03 Lt. 03",
"complement": "",
"district": "São José I",
"city": "Formoso do Araguaia",
"state": "TO",
"comments": "",
"client_since": "16/07/2015",
"myfinance_customer_id": 1856713,
"myfinance_errors": null,
"created_at": "21/09/2016 22:05:47 -03:00"
},
{
"id": 1054,
"account_id": 29,
"name": "Maria Aparecida",
"cpf": "82324547333",
"email": "maparec@email.com.br",
"zipcode": "01317000",
"address": "Avenida Brigadeiro Luís Antônio",
"number": "613",
"complement": "7º andar",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"comments": null,
"client_since": "28/12/2017",
"myfinance_customer_id": 2176117,
"myfinance_errors": null,
"created_at": "11/01/2018 22:39:20 -02:00"
},
{
"id": 410,
"account_id": 29,
"name": "Fatima Dias Borges",
"cpf": "87932230640",
"email": "fulano@uol.com.br",
"zipcode": "45608834",
"address": "Ru dois",
"number": "14",
"complement": "terreo",
"district": "Jd Primavera",
"city": "Camassari",
"state": "BA",
"comments": null,
"client_since": "20/12/2015",
"myfinance_customer_id": 1693842,
"myfinance_errors": null,
"created_at": "21/09/2016 22:33:32 -03:00"
}
]
}
```s
Detalhes Pessoa
Mostra os detalhes de uma pessoa.
GET
api/v1/people/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"person": {
"id": 1543,
"account_id": 29,
"name": "Fulano de Tal",
"cpf": "82868688977",
"email": "fulano@email.com",
"zipcode": "02360100",
"address": "Rua Americanas",
"number": "12",
"complement": "",
"district": "Santana",
"city": "São Paulo",
"state": "SP",
"comments": "",
"client_since": null,
"myfinance_customer_id": 2416551,
"myfinance_errors": null,
"created_at": "05/12/2018 14:03:36 -02:00"
}
}
Atualiza Pessoa
Atualiza uma pessoa.
PATCH
api/v1/people/{id}
O corpo da requisição deverá conter somente o(s) campo(s) que deseja(m) ser atualizado(s), tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"person": {
"name": "Beltrano",
}
}
Exemplo do retorno
{
"person": {
"id": 1543,
"account_id": 29,
"name": "Beltrano",
"cpf": "82868688977",
"email": "fulano@email.com",
"zipcode": "02360100",
"address": "Rua Americanas",
"number": "12",
"complement": "",
"district": "Santana",
"city": "São Paulo",
"state": "SP",
"comments": "",
"client_since": null,
"myfinance_customer_id": 2416551,
"myfinance_errors": null,
"created_at": "05/12/2018 14:03:36 -02:00"
}
}
Exclui Pessoa
Excluir uma pessoa.
DELETE
api/v1/people/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
Serviços
Lista serviço(s)
Lista o(s) serviço(s) em uma conta
GET
api/v1/service_items
Exemplo de Corpo
{
"Essa requisição não possui corpo"
}
Exemplo do retorno
{
"service_items": [
{
"id": 2,
"account_id": 1,
"name": "Serviço #2",
"description": "Descrição serviço 2",
"value": "200.0",
"unit": "item"
},
{
"id": 1,
"account_id": 1,
"name": "Serviço #1",
"description": "Descrição serviço 1",
"value": "100.0",
"unit": "item"
}
]
}
Cria Serviço
Cria novo serviço
POST
api/v1/service_items
Exemplo de Corpo
{
"name": "Teste Doc",
"description": "Descrição do item de Item de serviços ",
"value": "7900"
}
Exemplo do retorno
{
"service_item": {
"id": 943,
"account_id": 29,
"name": "Teste Doc",
"description": "Descrição do item de Item de serviços ",
"value": "7900.0",
"unit": "item"
}
}
Campos
| Campo | Finalidade |
|---|---|
| name (string) | Nome |
| description (string) | Descrição |
| value (string, optional) | Valor Unitário |
Busca Serviço
Realiza busca de serviços
GET
api/v1/service_items/search?name=Teste%20Doc
Onde name=Teste%20Doc é a descrição do serviço que deseja efetuar a busca
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"service_item": {
"id": 943,
"account_id": 29,
"name": "Teste Doc",
"description": "Descrição do item de Item de serviços ",
"value": "7900.0",
"unit": "item"
}
}
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Atualiza Serviço
Atualiza um serviço
PATCH
api/v1/service_items/{id}
O corpo da requisição deverá conter somente o(s) campo(s) que deseja(m) ser atualizado(s), tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"name": "Novo Item de serviço",
"description": "Teste para Doc - Novo Item de Serviço",
"value": "4600"
}
Exemplo do retorno
{
"service_item": {
"id": 943,
"account_id": 29,
"name": "Novo Item de serviço",
"description": "Teste para Doc - Novo Item de Serviço",
"value": "4600.0",
"unit": "item"
}
}
Exclui Serviço
Exclui um serviço
DELETE
api/v1/service_items/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Planos
Cria Plano
Cria um novo plano
POST
api/v1/organizations/{organization_id}/plans
Descrição dos campos logo abaixo dos exemplos
Exemplo de Corpo
{
"name": "Plano Teste Doc",
"description": "Plano de testes para documentação",
"price": "decimal",
"billing_period": "3",
"trial_period": 0,
"has_trial": false,
"redirect_url": "https://www.myfc.com.br",
"charging_method": "",
"readjustment_will_be_created": false,
"readjustment_month_quantity": 0,
"price_index": "",
"readjustment_days_until_update": 0,
"billet_notification_ruler_id": "",
"payment_gateway_notification_ruler_id": "",
"emites_service_values_id": "",
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": "1",
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": "",
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": "1",
"cobrato_payment_gateway_charge_config_name": "",
"finance_revenue_center": "",
"finance_category": "",
"myfinance_billet_sale_account_id": "1",
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": "1",
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": 0,
"features": {
"id": "",
"description": "",
"value": "",
"tag": 0,
"_destroy": false
},
"products": {
"id": "",
"service_item_id": "",
"description": "",
"units": 0,
"unit_value": 0,
"value": 0,
"_destroy": false
}
}
Exemplo do retorno
{
"plan": {
"id": 783,
"name": "Plano Teste Doc",
"description": "Plano de testes para documentação",
"redirect_url": "https://www.myfc.com.br",
"price": "0.0",
"billing_period": 3,
"translated_billing_period": "Trimestralmente",
"charging_method": null,
"translated_charging_method": {
"pre_paid": "Pré-pago",
"post_paid": "Pós-pago"
},
"has_trial": false,
"trial_period": 0,
"features": [],
"readjustment_will_be_created": false,
"readjustment_month_quantity": null,
"price_index": null,
"readjustment_days_until_update": null,
"billet_notification_ruler_id": null,
"payment_gateway_notification_ruler_id": null,
"emites_service_values_id": null,
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": 1,
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": null,
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_billet_sale_account_id": 1,
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": 1,
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": 0,
"created_at": "06/12/2018 11:37:22 -02:00",
"products": []
}
}
Campos do node principal
| Campo | Finalidade |
|---|---|
| name (string) | Nome do plano |
| description (string) | Descrição |
| price (decimal) | Preço |
| billing_period (integer) | Periodicidade de Cobrança Valores permitidos: 1-mensal 2-bimestral 3-trimestral 6-semestral 12-anual |
| trial_period (integer optional) | Dias de Degustação |
| has_trial (boolean optional) | Possui período de degustação ? |
| redirect_url (string optional) | URL de redirecionamento |
| charging_method (string optional) | Forma de Cobrança. (Opções 'pre_paid' ou 'post_paid') |
| readjustment_will_be_created (boolean) | Se haverá reajuste no plano |
| readjustment_month_quantity (integer optional) | Periodicidade mensal do reajuste |
| price_index (string optional) | Índice financeiro para o reajuste (igpm ipca igpdi inpc ou ipcfipe) |
| readjustment_days_until_update(integer optional) | Quantidade de dias para notificação antes do reajuste |
| billet_notification_ruler_id (integer optional) | ID da Régua de Cobrança de Boleto Bancário para ser associada à regra de faturamento |
| payment_gateway_notification_ruler_id (integer) | ID da Régua de Cobrança de Cartão de Credito para ser associada à regra de faturamento |
| emites_service_values_id (integer optional) | ID do Modelo de NFS-e |
| emites_service_value_name (string optional) | Nome do Modelo de NFS-e |
| cobrato_billet_charge_config_id(integer optional) | ID da Configuração de Cobrança para Boleto Bancário (obrigatório para cobranças pagas em boleto) |
| cobrato_billet_charge_config_name(string optional) | Nome da Configuração de Cobrança para Boleto Bancário (obrigatório para cobranças pagas em boleto) |
| cobrato_billet_charge_template_id(integer optional) | ID do Modelo de Cobrança para Boleto Bancário |
| cobrato_billet_charge_template_name(string optional) | Nome do Modelo de Cobrança para Boleto Bancário |
| cobrato_payment_gateway_charge_config_id(intr opt) | ID da Configuração de Cobrança para Cartão de Crédito (obrigatório - cobranças pagas cart de crédito) |
| cobrato_payment_gateway_charge_config_name (string opt) | Nome da Configuração de Cobrança para Cartão de Crédito (obrigatório - cobranças pagas em car crédito) |
| finance_revenue_center (string optional) | Centro de Receita |
| finance_category (string optional) | Categoria |
| myfinance_billet_sale_account_id (integer optional) | ID da Conta de Recebível para Boleto Bancário (obrig - criação de recebíveis no Myfinance pagos em boleto) |
| myfinance_billet_sale_account_name (string optional) | Nome da Conta de Recebível para Boleto Bancário(obrig -criação de recebíveis no Myfinance pagos em boleto) |
| myfinance_payment_gateway_sale_account_id (integer opt) | ID Conta Recebível p/ C. Crédito (obrig p/criação de recebíveis no Myfinance pagos em cartão de crédito) |
| myfinance_payment_gateway_sale_account_name (string opt) | Nome Conta de Recebível p/C. de Crédito (obrig p/ criação de recebíveis no Myfinance pagos CC) |
| allow_installments (boolean optional) | Permite parcelamento em cartão de crédito ? |
| installments_limit (integer optional) | Quantidade de parcelas permitidas |
| features (Feature optional) | Características do plano (Array) |
| products (Product optional) | Produtos (Array) |
Campos node Feature
| Campo | Finalidade |
|---|---|
| id (integer optional) | ID da característica no plano |
| description (string) | Descrição da característica |
| value (string) | Valor da característica |
| tag (integer optional) | Tag da característica |
| _destroy (boolean optional) | Se a característica deve ser excluída |
Campos node Product
| Campo | Finalidade |
|---|---|
| id (integer optional) | ID do produto no plano |
| service_item_id (integer) | ID do Serviço |
| description (string optional) | Descrição do produto |
| units (integer) | Quantidade |
| unit_value (integer) | Valor Unitário |
| value (integer) | Valor Total |
| _destroy (boolean optional) | Se o produto deve ser excluído |
Lista Plano(s)
Lista todos os planos de uma organização
GET
api/v1/organizations/{organization_id}/plans
Exemplo: api/v1/organizations/2115/plans
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"plans": [
{
"id": 783,
"name": "Plano Teste Doc",
"description": "Plano de testes para documentação",
"redirect_url": "https://www.myfc.com.br",
"price": "0.0",
"billing_period": 3,
"translated_billing_period": "Trimestralmente",
"charging_method": null,
"translated_charging_method": {
"pre_paid": "Pré-pago",
"post_paid": "Pós-pago"
},
"has_trial": false,
"trial_period": 0,
"features": [],
"readjustment_will_be_created": false,
"readjustment_month_quantity": null,
"price_index": null,
"readjustment_days_until_update": null,
"billet_notification_ruler_id": null,
"payment_gateway_notification_ruler_id": null,
"emites_service_values_id": null,
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": 1,
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": null,
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_billet_sale_account_id": 1,
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": 1,
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": 0,
"created_at": "06/12/2018 11:37:22 -02:00",
"products": []
}
]
}
Atualiza Plano
Atualiza um plano
PATCH
api/v1/organizations/{organization_id}/plans/{id}
Exemplo: api/v1/organizations/2115/plans/783
O corpo deverá conter somente os campos que deseja ser atualizados, tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"name": "Plano Teste Doc Atualizado"
}
Exemplo do retorno
{
"plan": {
"id": 783,
"name": "Plano Teste Doc Atualizado",
"description": "Plano de testes para documentação",
"redirect_url": "https://www.myfc.com.br",
"price": "0.0",
"billing_period": 3,
"translated_billing_period": "Trimestralmente",
"charging_method": null,
"translated_charging_method": {
"pre_paid": "Pré-pago",
"post_paid": "Pós-pago"
},
"has_trial": false,
"trial_period": null,
"features": [],
"readjustment_will_be_created": false,
"readjustment_month_quantity": null,
"price_index": null,
"readjustment_days_until_update": null,
"billet_notification_ruler_id": null,
"payment_gateway_notification_ruler_id": null,
"emites_service_values_id": null,
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": 1,
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": null,
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_billet_sale_account_id": 1,
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": 1,
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": null,
"created_at": "06/12/2018 11:37:22 -02:00",
"products": []
}
}
Exclui Plano
Exclui um plano
DELETE
api/v1/organizations/{organization_id}/plans/{id}
Exemplo: api/v1/organizations/2159/plans/33
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Contratos
Cria Contrato
Cria novo contrato
POST
api/v1/contracts
Exemplo de Corpo
{
"kind": "sale",
"name": "Contrato Desenvolvimento de Software ABD",
"title": "Contrato Desenvolvimento de Software",
"customer_id": "1617",
"customer_type": "Person",
"supplier_id": "486",
"supplier_type": "Company"
}
Exemplo do retorno
{
"contract": {
"id": 11984,
"name": "Contrato Desenvolvimento de Software ABD",
"title": "Contrato Desenvolvimento de Software",
"token": "cebec471e33560b9c579217acd739b04",
"description": null,
"customer_id": 1617,
"customer_type": "Person",
"supplier_id": 486,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": null,
"end_date": null,
"created_at": "07/12/2018 13:34:29 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": null,
"status": "established",
"registration_method": "regular",
"cobrato_payment_gateway_charge_config_id": null,
"cobrato_payment_gateway_charge_config_name": null,
"cancel_date": null,
"cancel_reason": null,
"overdue_automatic_management": false,
"plan": null
}
}}
Campos
| Campo | Finalidade |
|---|---|
| kind (string) | Tipo |
| name (string) | Nome |
| title (string) | Título |
| customer_id (string) | Id do cliente |
| customer_type (string) | Tipo do cliente (Company ou Person) |
| supplier_id (string) | Id do fornecedor |
| supplier_type (string) | Tipo do fornecedor(Company ou Person) |
| description (string, optional) | Descrição |
| comments (string, optional) | Observações |
| init_date (date, optional): | Início Formato: dd-mm-yyyy |
| end_date (date, optional) | Fim Formato: dd-mm-yyyy |
| cobrato_payment_gateway_charge_config_id (integer, optional) | ID da Configuração de Cobrança para Cartão de Crédito |
| cobrato_payment_gateway_charge_config_name (string, optional) | Nome da Configuração de Cobrança para Cartão de Crédito |
| overdue_automatic_management (boolean, optional) | Permitir faturamento automático em caso de inadimplência. (Se 'registration_method' for 'subscription', ou não informado, será false) |
Lista Contrato(s)
Lista os contratos ativos de uma organização
GET
api/v1/organizations/{organization_id}/contracts
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"contracts": [
{
"id": 11984,
"name": "Contrato Desenvolvimento de Software ABD",
"title": "Contrato Desenvolvimento de Software",
"token": "cebec471e33560b9c579217acd739b04",
"description": null,
"customer_id": 1617,
"customer_type": "Person",
"supplier_id": 486,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": null,
"end_date": null,
"created_at": "07/12/2018 13:34:29 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": null,
"status": "established",
"registration_method": "regular",
"cobrato_payment_gateway_charge_config_id": null,
"cobrato_payment_gateway_charge_config_name": null,
"cancel_date": null,
"cancel_reason": null,
"overdue_automatic_management": false,
"plan": null
}
]
}
Busca Contrato
Realiza busca de contratos
GET
api/v1/contracts/search?name=teste
Onde "teste" deverá ser o nome do seu contrato
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"contracts": [
{
"id": 11984,
"name": "Contrato Desenvolvimento de Software ABD",
"title": "Contrato Desenvolvimento de Software",
"token": "cebec471e33560b9c579217acd739b04",
"description": null,
"customer_id": 1617,
"customer_type": "Person",
"supplier_id": 486,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": null,
"end_date": null,
"created_at": "07/12/2018 13:34:29 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": null,
"status": "established",
"registration_method": "regular",
"cobrato_payment_gateway_charge_config_id": null,
"cobrato_payment_gateway_charge_config_name": null,
"cancel_date": null,
"cancel_reason": null,
"overdue_automatic_management": false,
"plan": null
}
]
}
Detalhes Contrato
Mostra detalhes de um contrato através de seu id
GET
api/v1/organizations/{organization_id}/contracts/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"contract": {
"id": 11984,
"name": "Contrato Desenvolvimento de Software ABD",
"title": "Contrato Desenvolvimento de Software",
"token": "bc46ab3fa231fc373e0f64ded6c36f6a",
"description": null,
"customer_id": 1617,
"customer_type": "Person",
"supplier_id": 486,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": null,
"end_date": null,
"created_at": "07/12/2018 14:11:37 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": null,
"status": "established",
"registration_method": "regular",
"cobrato_payment_gateway_charge_config_id": null,
"cobrato_payment_gateway_charge_config_name": null,
"cancel_date": null,
"cancel_reason": null,
"overdue_automatic_management": false,
"plan": null
}
}
Atualizar Contrato
Atualiza um contrato
PATCH
api/v1/contracts/{id}
api/v1/contracts/11985
Onde 11985 é o ID do contrato que deseja atualizar
O corpo da requisição deverá conter somente o(s) campo(s) que deseja(m) ser atualizado(s), tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"comments": "Contrato de cliente vips",
"overdue_automatic_management": true
}
Exemplo do retorno
{
"contract": {
"id": 11985,
"name": "Contrato Desenvolvimento de Software ABF",
"title": "Contrato Desenvolvimento de Software",
"token": "bc46ab3fa231fc373e0f64ded6c36f6a",
"description": null,
"customer_id": 1617,
"customer_type": "Person",
"supplier_id": 486,
"supplier_type": "Company",
"state": "active",
"comments": "Contrato de cliente vips",
"init_date": null,
"end_date": null,
"created_at": "07/12/2018 14:11:37 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": null,
"status": "established",
"registration_method": "regular",
"cobrato_payment_gateway_charge_config_id": null,
"cobrato_payment_gateway_charge_config_name": null,
"cancel_date": null,
"cancel_reason": null,
"overdue_automatic_management": true,
"plan": null
}
}
Exclui Contrato
Exclui um contrato
DELETE
api/v1/contracts/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Assinaturas
Cria Assinatura
Cria uma assinatura de degustação
POST
api/v1/subscriptions
Exemplo de Corpo
{
"subscription": {
"plan_id": 783,
"customer": {
"name": "Empresa Teste",
"email": "contato@email.com",
"document": "58763913000140"
},
"addressInformation": {
"address": "Rua do Carmo",
"number": "43",
"complement": "",
"district": "Centro",
"zipcode": "20011020",
"city": "Rio de Janeiro",
"state": "RJ"
}
}
}
Exemplo do retorno
{
"subscription": {
"id": 11987,
"name": "Assinatura Empresa Teste - Plano Teste Doc Atualizado",
"title": "Assinatura Empresa Teste - Plano Teste Doc Atualizado",
"token": "c6dd212d12c665938616475c8fd6e528",
"description": null,
"customer_id": 9517,
"supplier_id": 2115,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": "11/12/2018",
"end_date": "11/12/2018",
"created_at": "11/12/2018 11:11:47 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": "11/12/2018",
"status": "trial",
"registration_method": "subscription",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"cancel_date": null,
"cancel_reason": null,
"plan": {
"id": 783,
"name": "Plano Teste Doc Atualizado",
"description": "Plano de testes para documentação",
"redirect_url": "https://www.myfc.com.br",
"price": "0.0",
"billing_period": 3,
"translated_billing_period": "Trimestralmente",
"charging_method": null,
"translated_charging_method": {
"pre_paid": "Pré-pago",
"post_paid": "Pós-pago"
},
"has_trial": false,
"trial_period": null,
"features": [],
"readjustment_will_be_created": false,
"readjustment_month_quantity": null,
"price_index": null,
"readjustment_days_until_update": null,
"billet_notification_ruler_id": null,
"payment_gateway_notification_ruler_id": null,
"emites_service_values_id": null,
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": 1,
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": null,
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_billet_sale_account_id": 1,
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": 1,
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": null,
"created_at": "06/12/2018 11:37:22 -02:00",
"products": []
}
}
}
Campos
| Campo | Finalidade |
|---|---|
| plan_id (integer) | ID do plano escolhido para a assinatura (somente para criação de assinatura) |
| cancel_date (date, optional) | Data do cancelamento da assinatura (somente para cancelamento de assinatura) |
| cancel_reason (string, optional) | Motivo do cancelamento da assinatura (somente para cancelamento de assinatura) |
| customer (Customer) | Informações sobre o cliente da assinatura (somente para criação de assinatura) |
Campos do node Customer
| Campo | Finalidade |
|---|---|
| name (string) | Nome completo do cliente (Nome fantasia em caso de Pessoa Jurídica) |
| email (string) | E-mail para contato |
| document (string, optional) | CPF (Pessoa Física) / CNPJ (Pessoa Jurídica) |
| state_inscription (string, opt) | Inscrição Estadual (para Pessoa Jurídica) |
| city_inscription (string, opt) | Inscrição Municipal (para Pessoa Jurídica) |
| address_information (AddressInformation, opt) | Informações de endereço do cliente |
Campos do node AddressInformation
| Campo | Finalidade |
|---|---|
| address (string, optional) | Endereço |
| number (string, optional) | Número |
| complement (string, optional) | Complemento |
| district (string, optional) | Bairro |
| zipcode (string, optional) | CEP |
| city (string, optional) | Cidade |
| state (string, optional) | Estado |
Detalhes de Assinaturas
Mostra detalhes de uma assinatura através de seu token
GET
api/v1/subscriptions/token/c6dd212d12c665938616475c8fd6e528
Onde c6dd212d12c665938616475c8fd6e528 deve ser o token da assinatura em que deseja saber os detalhes
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"subscription": {
"id": 11987,
"name": "Assinatura Empresa Teste - Plano Teste Doc Atualizado",
"title": "Assinatura Empresa Teste - Plano Teste Doc Atualizado",
"token": "c6dd212d12c665938616475c8fd6e528",
"description": null,
"customer_id": 9517,
"supplier_id": 2115,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": "11/12/2018",
"end_date": "11/12/2018",
"created_at": "11/12/2018 11:11:47 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": "11/12/2018",
"status": "trial",
"registration_method": "subscription",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"cancel_date": null,
"cancel_reason": null,
"plan": {
"id": 783,
"name": "Plano Teste Doc Atualizado",
"description": "Plano de testes para documentação",
"redirect_url": "https://www.myfc.com.br",
"price": "0.0",
"billing_period": 3,
"translated_billing_period": "Trimestralmente",
"charging_method": null,
"translated_charging_method": {
"pre_paid": "Pré-pago",
"post_paid": "Pós-pago"
},
"has_trial": false,
"trial_period": null,
"features": [],
"readjustment_will_be_created": false,
"readjustment_month_quantity": null,
"price_index": null,
"readjustment_days_until_update": null,
"billet_notification_ruler_id": null,
"payment_gateway_notification_ruler_id": null,
"emites_service_values_id": null,
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": 1,
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": null,
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_billet_sale_account_id": 1,
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": 1,
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": null,
"created_at": "06/12/2018 11:37:22 -02:00",
"products": []
}
}
}
Cancelamento de Assinatura
Cancela uma assinatura
PATCH
api/v1/subscriptions/c6dd212d12c665938616475c8fd6e528/cancel
Onde c6dd212d12c665938616475c8fd6e528 deverá ser o token da assinatura em que deseja cancelar
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"subscription": {
"id": 11987,
"name": "Assinatura Empresa Teste - Plano Teste Doc Atualizado",
"title": "Assinatura Empresa Teste - Plano Teste Doc Atualizado",
"token": "c6dd212d12c665938616475c8fd6e528",
"description": null,
"customer_id": 9517,
"supplier_id": 2115,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": "11/12/2018",
"end_date": "11/12/2018",
"created_at": "11/12/2018 11:11:47 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": "11/12/2018",
"status": "trial",
"registration_method": "subscription",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"cancel_date": null,
"cancel_reason": null,
"plan": {
"id": 783,
"name": "Plano Teste Doc Atualizado",
"description": "Plano de testes para documentação",
"redirect_url": "https://www.myfc.com.br",
"price": "0.0",
"billing_period": 3,
"translated_billing_period": "Trimestralmente",
"charging_method": null,
"translated_charging_method": {
"pre_paid": "Pré-pago",
"post_paid": "Pós-pago"
},
"has_trial": false,
"trial_period": null,
"features": [],
"readjustment_will_be_created": false,
"readjustment_month_quantity": null,
"price_index": null,
"readjustment_days_until_update": null,
"billet_notification_ruler_id": null,
"payment_gateway_notification_ruler_id": null,
"emites_service_values_id": null,
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": 1,
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": null,
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_billet_sale_account_id": 1,
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": 1,
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": null,
"created_at": "06/12/2018 11:37:22 -02:00",
"products": []
}
}
}
Plano de assinaturas
Trocas de plano de assinaturas
Realiza processo de troca de plano de uma assinatura
PATCH
api/v1/subscriptions/0666d723565dc5f829935fd3060baf13/change_plan
Onde 0666d723565dc5f829935fd3060baf13 deverá ser o Token da assinatura
Será necessário informar o ID do novo plano, através do campo "new_plan_id", conforme exemplo abaixo
Exemplo de Corpo
{
"subscription":
{
"new_plan_id": 792
}
}
Exemplo do retorno
{
"subscription": {
"id": 11989,
"name": "Assinatura Empresa Teste Ltda - Plano Teste Doc",
"title": "Assinatura Empresa Teste Ltda - Plano Teste Doc",
"token": "0666d723565dc5f829935fd3060baf13",
"description": null,
"customer_id": 2123,
"supplier_id": 2115,
"supplier_type": "Company",
"state": "active",
"comments": null,
"init_date": "11/12/2018",
"end_date": null,
"created_at": "11/12/2018 14:20:22 -02:00",
"kind": "sale",
"overdue": false,
"valid_until": "11/03/2019",
"status": "established",
"registration_method": "subscription",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"cancel_date": null,
"cancel_reason": null,
"plan": {
"id": 792,
"name": "Plano Teste Doc",
"description": "Plano de testes para documentação",
"redirect_url": "https://www.myfc.com.br",
"price": "0.0",
"billing_period": 3,
"translated_billing_period": "Trimestralmente",
"charging_method": null,
"translated_charging_method": {
"pre_paid": "Pré-pago",
"post_paid": "Pós-pago"
},
"has_trial": false,
"trial_period": 0,
"features": [],
"readjustment_will_be_created": false,
"readjustment_month_quantity": null,
"price_index": null,
"readjustment_days_until_update": null,
"billet_notification_ruler_id": null,
"payment_gateway_notification_ruler_id": null,
"emites_service_values_id": null,
"emites_service_value_name": "",
"cobrato_billet_charge_config_id": 1,
"cobrato_billet_charge_config_name": "",
"cobrato_billet_charge_template_id": null,
"cobrato_billet_charge_template_name": "",
"cobrato_payment_gateway_charge_config_id": 1,
"cobrato_payment_gateway_charge_config_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_billet_sale_account_id": 1,
"myfinance_billet_sale_account_name": "",
"myfinance_payment_gateway_sale_account_id": 1,
"myfinance_payment_gateway_sale_account_name": "",
"allow_installments": false,
"installments_limit": 0,
"created_at": "11/12/2018 14:49:21 -02:00",
"products": []
},
"payment_information": {
"id": 28441,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": 1,
"created_at": "11/12/2018 14:28:43 -02:00"
}
}
}
Faturamentos
Cria Faturamento
Cria um faturamento
POST
api/v1/contracts/{contract_id}/invoices
Exemplo de Corpo
{
"invoice": {
"contract_id": 11986,
"gross_value": 700.0,
"number": 2,
"issue_date": "02-12-2018",
"accrual_date": "",
"description": "Teste Doc",
"nfse_service": "",
"nfse_verification": "",
"payment_value": "decimal",
"nfse_template_id": 1,
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": "",
"myfinance_sale_account_name": "",
"nfe_body": "Nfe teste ",
"cobrato_charge_config_id": "",
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": "",
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"comments": 0,
"receivables":
[
{
"value": 100,
"due_date": "02-12-2019"
}
],
"services": [
{
"service_item_id": "383",
"description": "Teste",
"units": 100,
"unit_value": 100,
"value": 100
}
],
"attachments": [
{
"filename": "teste",
"content": "tst",
"content_type": "application/vnd.ms-excel"
}
],
"payment_information": {
"payment_method": "billet"
}
}
}
Exemplo do retorno
{
"invoice": {
"id": 184535,
"contract_id": 11986,
"issue_date": "02/12/2018",
"estimated_issue_date": "02/12/2018",
"gross_value": "10000.0",
"payment_value": "0.0",
"description": "Teste Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe teste ",
"nfe_issued": false,
"number": "2",
"created_at": "10/12/2018 10:55:10 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": "0",
"customer_id": 1954,
"customer_type": "Company",
"nfse_template_id": 1,
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"receivables": [
{
"id": 182348,
"invoice_id": 184535,
"due_date": "02/12/2019",
"value": "100.0",
"gross_value": "10000.0",
"payment_value": "0.0",
"received_value": null,
"received_at": null,
"created_at": "10/12/2018 10:55:11 -02:00",
"state": "to_emit",
"payment_gateway_status": null,
"cobrato_charge_id": null,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": null
}
],
"services": [
{
"id": 246203,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
}
],
"attachments": [
{
"id": 44,
"filename": "teste",
"url": "http://pscontracts-sand.s3.amazonaws.com/attachments/attachments/000/000/044/original/teste?1544446510"
}
],
"payment_information": {
"id": 28392,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 10:55:10 -02:00"
}
}
}
Campos
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID do faturamento |
| contract_id (integer, optional) | ID do contrato |
| gross_value (float, optional) | Valor Bruto |
| number (integer, optional) | Número da Nota |
| issue_date (date) | Faturamento |
| estimated_issue_date (date, optional) | Previsão. Se não informada, será a data de Faturamento |
| accrual_date (string, optional) | Mês de Competência. Formato: 'mm/aaaa' |
| description (string) | Descrição |
| approval_status (string, optional) | Status de aprovação do faturamento. (Opções: 'approved' ou 'blocked') |
| nfse_service (string, optional) | Código do Serviço |
| nfse_verification (string, optional) | Código de Verificação |
| payment_value (decimal, optional) | Valor a Receber |
| nfse_template_id (integer, optional) | ID do Modelo de NFS-e |
| finance_category (string, optional) | Categoria |
| finance_revenue_center (string, optional) | Centro de Receita |
| myfinance_sale_account_id (integer, optional) | ID da Conta de Recebível (obrig p/ criação de recebível no Myfinance) |
| myfinance_sale_account_name (string, optional) | Nome da Conta de Recebível (obrig p/ criação criação de recebível no Myfinance) |
| nfe_issued (boolean, optional) | Se a NFS-e foi emitida |
| nfe_issue_date (integer, optional) | Emissão da Nota |
| nfe_body (string) | Corpo da NFS-e |
| cobrato_charge_config_id (integer, optional) | ID da Configuração de Cobrança (Cobrato) |
| cobrato_charge_config_name (string, optional) | Nome da Configuração de Cobrança (Cobrato) |
| cobrato_charge_template_id (integer, optional) | ID do Modelo de Cobrança (Cobrato) |
| cobrato_charge_template_name (string, optional) | Nome do Modelo de Cobrança (Cobrato) |
| management_type (string, optional) | Tipo de Faturamento. (Opções: 'manual' ou 'automatic') |
| automatic_email_template_id (integer, optional) | ID do Modelo de Notificação Automática (obrigatório para faturamentos automáticos) |
| notification_ruler_id (integer, optional) | ID da Régua de Cobrança para o faturamento |
| days_until_automatic_nfe_emission (integer, optional) | Quantidade de dias úteis após o recebimento para emissão automática de NF-e (0 para emissão na data do faturamento) |
| comments (integer, optional) | Observações |
| receivables (Receivable) | Vencimentos (Array) |
| services (Service, optional) | Serviços (Array) |
| attachments (Attachment, optional) | Anexos (Array) |
| payment_information (PaymentInformation, optional) | Informações de pagamento |
- Possibilidades Campo: approval_status poderá conter: 'approved' para aprovado, 'blocked' para bloqueado (apenas para criação de faturamentos)
Campos do node Receivable
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID do vencimento |
| due_date (date) | Data do vencimento |
| value (integer, optional) | % do valor bruto do faturamento |
| _destroy (boolean, optional) | Se o vencimento deve ser excluído |
Campos do node Service
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID do serviço no faturamento |
| service_item_id (integer) | ID do Serviço |
| description (string, optional) | Descrição do serviço |
| units (integer) | Quantidade |
| unit_value (integer) | Valor Unitário |
| value (integer, optional) | Valor Total |
| _destroy (boolean, optional) | Se o serviço deve ser excluído |
Campos do node Attachment
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID do anexo |
| filename (string) | Nome original do arquivo. Ex: planilha.xlsx |
| content (string) | Representação em Base64 do conteúdo do arquivo |
| content_type (string) | Tipo de conteúdo do arquivo. Ex: application/pdf |
| _destroy (boolean, optional) | Se o anexo deve ser excluído |
Campos do node PaymentInformation
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID das informações de pagamento |
| payment_method (string, optional) | Forma de pagamento ('billet' para boleto bancário, 'payment_gateway' para cartão de crédito, 'transfer' para transferência bancária) |
| installments | Quantidade de parcelas para pagamento em cartão de crédito. Valor apenas aceito para ‘payment_method’ como ‘payment_gateway’ (Pode ser igual ou maior que 1; caso seja null, será considerada apenas 1 parcela). Caso o ‘payment_method’ seja ‘billet’ ou ‘transfer’, o valor é null. |
Detalhes Faturamento
Mostra detalhes de um faturamento através de seu id
GET
api/v1/contracts/{contract_id}/invoices/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoice": {
"id": 184535,
"contract_id": 11986,
"issue_date": "02/12/2018",
"estimated_issue_date": "02/12/2018",
"gross_value": "10000.0",
"payment_value": "0.0",
"description": "Teste Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe teste ",
"nfe_issued": false,
"number": "2",
"created_at": "10/12/2018 10:55:10 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": "0",
"customer_id": 1954,
"customer_type": "Company",
"nfse_template_id": 1,
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"receivables": [
{
"id": 182348,
"invoice_id": 184535,
"due_date": "02/12/2019",
"value": "100.0",
"gross_value": "10000.0",
"payment_value": "0.0",
"received_value": null,
"received_at": null,
"created_at": "10/12/2018 10:55:11 -02:00",
"state": "to_emit",
"payment_gateway_status": null,
"cobrato_charge_id": null,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": "Ocorreu um erro ao criar recebível no Myfinance. Verifique os erros: A entidade 57.757.975/0001-86 não foi encontrada no Myfinance. Corrija o faturamento e sincronize."
}
],
"services": [
{
"id": 246203,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
}
],
"attachments": [
{
"id": 44,
"filename": "teste",
"url": "http://pscontracts-sand.s3.amazonaws.com/attachments/attachments/000/000/044/original/teste?1544446510"
}
],
"payment_information": {
"id": 28392,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 10:55:10 -02:00"
}
}
}
Atualiza Faturamento
Atualiza um faturamento
PATH
api/v1/contracts/{contract_id}/invoices/{id}
O corpo da requisição deverá conter somente o(s) campo(s) que deseja(m) ser atualizado(s), tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"invoice": {
"description": "Teste de alteração da descrição do faturamento para doc",
}
}
Exemplo do retorno
{
"invoice": {
"id": 184535,
"contract_id": 11986,
"issue_date": "02/12/2018",
"estimated_issue_date": "02/12/2018",
"gross_value": "20000.0",
"payment_value": "20000.0",
"description": "Teste de alteração da descrição do faturamento para doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe teste",
"nfe_issued": false,
"number": "2",
"created_at": "10/12/2018 10:55:10 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": "0",
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"receivables": [
{
"id": 182348,
"invoice_id": 184535,
"due_date": "02/12/2019",
"value": "100.0",
"gross_value": "20000.0",
"payment_value": "20000.0",
"received_value": null,
"received_at": null,
"created_at": "10/12/2018 10:55:11 -02:00",
"state": "to_emit",
"payment_gateway_status": null,
"cobrato_charge_id": null,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": "Ocorreu um erro ao criar recebível no Myfinance. Verifique os erros: A entidade 57.757.975/0001-86 não foi encontrada no Myfinance. Corrija o faturamento e sincronize."
}
],
"services": [
{
"id": 246203,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
},
{
"id": 246204,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
}
],
"attachments": [
{
"id": 44,
"filename": "teste",
"url": "http://pscontracts-sand.s3.amazonaws.com/attachments/attachments/000/000/044/original/teste?1544446510"
}
],
"payment_information": {
"id": 28393,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 11:36:23 -02:00"
}
}
}
Buscar Faturamento
Realiza busca de faturamentos por contrato, para o período especificado.
GET
api/v1/contracts/{contract_id}/invoices/search?issue_date_from=01-04-2018&issue_date_to=31-12-2018
Onde deseja que o faturamento esteja entre as datas 01/04/2018 a 31/12/2018
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoices": [
{
"id": 184535,
"contract_id": 11986,
"issue_date": "02/12/2018",
"estimated_issue_date": "02/01/2018",
"gross_value": "20000.0",
"payment_value": "20000.0",
"description": "Teste de alteração da descrição do faturamento para doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe teste",
"nfe_issued": false,
"number": "2",
"created_at": "10/12/2018 10:55:10 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": "0",
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"receivables": [
{
"id": 182348,
"invoice_id": 184535,
"due_date": "02/12/2019",
"value": "100.0",
"gross_value": "20000.0",
"payment_value": "20000.0",
"received_value": null,
"received_at": null,
"created_at": "10/12/2018 10:55:11 -02:00",
"state": "to_emit",
"payment_gateway_status": null,
"cobrato_charge_id": null,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": "Ocorreu um erro ao criar recebível no Myfinance. Verifique os erros: A entidade 57.757.975/0001-86 não foi encontrada no Myfinance. Corrija o faturamento e sincronize."
}
],
"services": [
{
"id": 246204,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
},
{
"id": 246203,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
}
],
"attachments": [
{
"id": 44,
"filename": "teste",
"url": "http://pscontracts-sand.s3.amazonaws.com/attachments/attachments/000/000/044/original/teste?1544446510"
}
],
"payment_information": {
"id": 28393,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 11:36:23 -02:00"
}
},
{
"id": 184522,
"contract_id": 11986,
"issue_date": "10/12/2018",
"estimated_issue_date": "10/12/2018",
"gross_value": "700.0",
"payment_value": "700.0",
"description": "teste",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "$DESCRICAO",
"nfe_issued": false,
"number": null,
"created_at": "10/12/2018 10:02:38 -02:00",
"management_type": "manual",
"accrual_date": "2018-12-01",
"comments": null,
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"receivables": [
{
"id": 182335,
"invoice_id": 184522,
"due_date": "03/01/2019",
"value": "100.0",
"gross_value": "700.0",
"payment_value": "700.0",
"received_value": null,
"received_at": null,
"created_at": "10/12/2018 10:02:39 -02:00",
"state": "to_emit",
"payment_gateway_status": null,
"cobrato_charge_id": null,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": "Ocorreu um erro ao criar recebível no Myfinance. Verifique os erros: A entidade 57.757.975/0001-86 não foi encontrada no Myfinance. Corrija o faturamento e sincronize."
}
],
"services": [
{
"id": 246190,
"name": "Serviço Teste Doc",
"description": "Serviço criado para testes internos da documentação",
"unit_value": "700.0",
"units": "1.0",
"value": "700.0"
}
],
"attachments": [],
"payment_information": {
"id": 28379,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 10:02:39 -02:00"
}
}
]
}
Faturamentos inadimplentes
Lista os faturamentos inadimplentes de um contrato
GET
api/v1/contracts/{contract_id}/invoices/late
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoices": [
{
"id": 180614,
"contract_id": 11724,
"issue_date": "30/08/2018",
"estimated_issue_date": "30/08/2018",
"gross_value": "222.0",
"payment_value": "222.0",
"description": "Teste cobrança sem registro",
"state": "to_receive",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": "",
"nfe_issue_date": null,
"nfe_body": "$DESCRICAO",
"nfe_issued": false,
"number": "",
"created_at": "30/08/2018 10:27:35 -03:00",
"management_type": "manual",
"accrual_date": null,
"comments": "",
"customer_id": 558,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": 99,
"cobrato_charge_config_name": "Conta da Taxweb",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"receivables": [
{
"id": 178146,
"invoice_id": 180614,
"due_date": "30/08/2018",
"value": "100.0",
"gross_value": "222.0",
"payment_value": "222.0",
"received_value": null,
"received_at": null,
"created_at": "30/08/2018 10:27:35 -03:00",
"state": "to_receive",
"payment_gateway_status": null,
"cobrato_charge_id": 18151,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": "Ocorreu um erro ao criar recebível no Myfinance. Verifique os erros: A entidade 24.272.120/0001-06 não foi encontrada no Myfinance. Corrija o faturamento e sincronize."
}
],
"services": [],
"attachments": [],
"payment_information": {
"id": 24323,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "30/08/2018 10:27:35 -03:00"
}
}
]
}
Bloqueia Faturamento
Bloqueia um faturamento
PATCH
api/v1/contracts/{contract_id}/invoices/{id}/block
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoice": {
"id": 184544,
"contract_id": 11986,
"issue_date": "02/01/2018",
"estimated_issue_date": "02/01/2018",
"gross_value": "10000.0",
"payment_value": "0.0",
"description": "Teste Doc para Inadimplen",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe teste ",
"nfe_issued": false,
"number": "2",
"created_at": "10/12/2018 14:20:47 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": "0",
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "blocked",
"notification_ruler_id": null,
"receivables": [
{
"id": 182357,
"invoice_id": 184544,
"due_date": "02/12/2019",
"value": "100.0",
"gross_value": "10000.0",
"payment_value": "0.0",
"received_value": null,
"received_at": null,
"created_at": "10/12/2018 14:20:47 -02:00",
"state": "to_emit",
"payment_gateway_status": null,
"cobrato_charge_id": null,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": "Ocorreu um erro ao criar recebível no Myfinance. Verifique os erros: A entidade 57.757.975/0001-86 não foi encontrada no Myfinance. Corrija o faturamento e sincronize."
}
],
"services": [
{
"id": 246213,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
}
],
"attachments": [
{
"id": 51,
"filename": "teste",
"url": "http://pscontracts-sand.s3.amazonaws.com/attachments/attachments/000/000/051/original/teste?1544458847"
}
],
"payment_information": {
"id": 28402,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 14:20:47 -02:00"
}
}
}
Aprova Faturamento
Aprova um faturamento
PATCH
api/v1/contracts/{contract_id}/invoices/{id}/approve
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoice": {
"id": 184549,
"contract_id": 11986,
"issue_date": "20/12/2018",
"estimated_issue_date": "20/12/2018",
"gross_value": "10000.0",
"payment_value": "0.0",
"description": "Teste Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe teste ",
"nfe_issued": false,
"number": "2",
"created_at": "10/12/2018 15:15:13 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": "0",
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"receivables": [
{
"id": 182362,
"invoice_id": 184549,
"due_date": "02/12/2019",
"value": "100.0",
"gross_value": "10000.0",
"payment_value": "0.0",
"received_value": null,
"received_at": null,
"created_at": "10/12/2018 15:15:14 -02:00",
"state": "to_emit",
"payment_gateway_status": null,
"cobrato_charge_id": null,
"cobrato_errors": null,
"finance_receivable_id": null,
"myfinance_sale_id": null,
"finance_entity_id": null,
"myfinance_errors": "Ocorreu um erro ao criar recebível no Myfinance. Verifique os erros: A entidade 57.757.975/0001-86 não foi encontrada no Myfinance. Corrija o faturamento e sincronize."
}
],
"services": [
{
"id": 246218,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "100.0",
"value": "10000.0"
}
],
"attachments": [
{
"id": 56,
"filename": "teste",
"url": "http://pscontracts-sand.s3.amazonaws.com/attachments/attachments/000/000/056/original/teste?1544462113"
}
],
"payment_information": {
"id": 28407,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 15:15:13 -02:00"
}
}
}
Exclui Faturamento
Excluir um faturamento
DELETE
api/v1/contracts/{contract_id}/invoices/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Regras de Faturamento
Cria Regra Faturamento
Cria uma regra de faturamento
POST
api/v1/contracts/{contract_id}/invoice_rules
Exemplo de Corpo
{
"invoice_rule":
{
"contract_id": 11986,
"gross_value": 100,
"description": "Regra de faturamento teste para Doc",
"nfe_body": "Nfe Teste para Regra de Faturamento",
"charge_type": "fixed_day",
"additional_information": {
"title": "Teste Documentacao",
"init_date": "01-12-2018",
"period_unit": "monthly",
"month_quantity": 3,
"accrual_month_quantity": "same_month"
},
"management_type": "manual",
"days_until_automatic_nfe_emission": 0,
"services":[
{
"service_item_id": 383,
"description": "Teste",
"units": 1,
"unit_value": 100,
"value": 100
}
],
"scheduled_updates":
[
{
"service_item_id": 383,
"init_date": "12-12-2018",
"month_quantity": 3,
"price_index": "ipca",
"days_until_update": 10
}
],
"receivables_additional_information":
{
"parcel_number": 1,
"day_number": 1,
"day_quantity": 1,
"only_business_days": false,
"month_quantity": 10
},
"payment_information": {
"payment_method": "billet"
}
}
}
Exemplo do retorno
{
"invoice_rule": {
"id": 184574,
"contract_id": 11986,
"issue_date": null,
"estimated_issue_date": null,
"gross_value": "100.0",
"payment_value": "100.0",
"description": "Regra de faturamento teste para Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe Teste para Regra de Faturamento",
"nfe_issued": false,
"number": null,
"created_at": "10/12/2018 17:03:19 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": null,
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": null,
"finance_category": null,
"finance_revenue_center": null,
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": null,
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": null,
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": null,
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"notify_customer": false,
"apply_negative_updates": false,
"receivables": [],
"services": [
{
"id": 246219,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "1.0",
"value": "100.0"
}
],
"attachments": [],
"payment_information": {
"id": 28410,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 17:03:19 -02:00"
},
"additional_information": {
"id": 7683,
"init_date": "2018-12-01",
"title": "Teste Documentacao",
"period_unit": "monthly",
"month_quantity": 3,
"end_date": null,
"created_at": "10/12/2018 17:03:19 -02:00",
"accrual_month_quantity": "same_month"
},
"scheduled_updates": [
{
"id": 527,
"invoice_rule_id": 184574,
"execution_date": "2018-12-12",
"month_quantity": 3,
"price_index": "ipca",
"created_at": "2018-12-10T17:03:19.193-02:00",
"updated_at": "2018-12-10T17:03:19.193-02:00",
"init_date": "2018-12-12",
"days_until_update": 10,
"remind_at": "2018-12-02",
"notified": false,
"service_item_id": 383
}
],
"receivables_additional_information": {
"id": 7690,
"day_number": 1,
"parcel_number": 1,
"invoice_rule_id": 184574,
"created_at": "2018-12-10T17:03:19.196-02:00",
"updated_at": "2018-12-10T17:03:19.196-02:00",
"day_quantity": null,
"month_quantity": null,
"only_business_days": false
}
}
}
Campos
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID da regra de faturamento |
| contract_id (integer, optional) | ID do contrato |
| gross_value (float, optional) | Valor Bruto |
| description (string) | Descrição |
| nfe_body (string) | Corpo da NFS-e |
| charge_type (string) | Tipo da cobrança dos vencimentos. (fixed_day => No próximo dia x após a data do faturamento / last_day_of_month => No último dia do mês após a data do faturamento / day_quantity => Após x dias da data do faturamento / fixed_day_and_month_quantity => No dia x após x mes(es) da data do faturamento |
| additional_information (AdditionalInformation) | Informações adicionais da regra |
| emites_service_values_id (integer, optional) | ID do Modelo de NFS-e (Emites) |
| emites_service_value_name (string, optional) | Nome do Modelo de NFS-e (Emites) |
| finance_category (string, optional) | Categoria |
| finance_revenue_center (string, optional) | Centro de Receita |
| myfinance_sale_account_id (integer, optional) | ID da Conta de Recebível (obrigatório para criação de recebível no Myfinance) |
| myfinance_sale_account_name (string, optional) | Nome da Conta de Recebível (obrigatório para criação de recebível no Myfinance) |
| cobrato_charge_config_id (integer, optional) | ID da Configuração de Cobrança (Cobrato) |
| cobrato_charge_config_name (string, optional) | Nome da Configuração de Cobrança (Cobrato) |
| cobrato_charge_template_id (integer, optional) | ID do Modelo de Cobrança (Cobrato) |
| cobrato_charge_template_name (string, optional) | Nome do Modelo de Cobrança (Cobrato) |
| management_type (string, optional) | Tipo de Faturamento. (Opções: 'manual' ou 'automatic') |
| automatic_email_template_id (integer, optional) | ID do Modelo de Notificação Automática (obrigatório para faturamentos automáticos) |
| days_until_automatic_nfe_emission (integer, optional) | Quantidade de dias úteis após o recebimento para emissão automática de NF-e (0 para emissão na data do faturamento) |
| notification_ruler_id (integer, optional) | ID da Régua de Cobrança para os faturamentos da regra |
| notify_customer (boolean, optional) | Notificar o cliente via e-mail sobre o(s) reajuste(s) |
| apply_negative_updates (boolean, optional) | Permitir reajuste(s) negativo(s) |
| services (Service, optional) | Serviços (Array) |
| scheduled_updates (ScheduledUpdate, optional) | Configurações de reajuste automático (Array), |
| receivables_additional_information | Informações de vencimento |
| payment_information (PaymentInformation, optional) | Informações de pagamento |
Campos do node AdditionalInformation
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID das informações adicionais da regra |
| title (string) | Título da regra recorrente |
| init_date (date) | Data de início da criação do primeiro faturamento |
| period_unit (string, optional) | Base de periodicidade para criação de faturamentos: 'weekly' para base semanal ou 'monthly' para base mensal |
| month_quantity (integer) | Periodicidade de criação de faturamentos, requerido apenas para base mensal. Valores permitidos: 1 (mensal), 2 (bimestral), 3 (trimestral), 6 (semestral), 12 (anual) |
| end_date (date, optional) | Data de fim da recorrência. (Se não informada, repete indefinidamente) |
| accrual_month_quantity (string) | Competência do faturamento (same_month => No mesmo mês da data do faturamento / previous_month => No mês anterior à data do faturamento) |
Campos do node Service
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID do serviço na regra recorrente |
| service_item_id (integer) | ID do Serviço |
| description (string, optional) | Descrição do serviço |
| units (integer) | Quantidade |
| unit_value (integer) | Valor Unitário |
| value (integer, optional) | Valor Total |
| _destroy (boolean, optional) | Se o serviço deve ser excluído |
Campos do node ScheduledUpdate
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID da configuração de reajuste automático |
| service_item_id (integer, optional) | ID do serviço a ser reajustado (deve estar presente na regra) |
| init_date (date) | Data de início do reajuste |
| month_quantity (integer) | Periodicidade mensal do reajuste |
| price_index (string) | Índice financeiro para o reajuste (igpm, ipca, igpdi, inpc ou ipcfipe) |
| days_until_update (integer) | Quantidade de dias para notificação antes do reajuste |
| _destroy (boolean, optional) | Se a configuração de reajuste deve ser excluída |
Campos do node ReceivablesAdditionalInformation
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID das informações de vencimento dos faturamentos |
| parcel_number (integer, optional) | Número de parcelas do vencimento |
| day_number (integer, optional) | Dia do mês do vencimento. (se charge_type for fixed_day ou fixed_day_and_month_quantity) |
| day_quantity (integer, optional) | Quantidade de dias para o vencimento (se charge_type for day_quantity) |
| only_business_days (boolean, optional) | Considerar apenas dias úteis (se charge_type for day_quantity ou last_day_of_month) |
| month_quantity (integer, optional) | Quantidade de meses para o vencimento. (Se charge_type for fixed_day_and_month_quantity) |
Campos do node PaymentInformation
| Campo | Finalidade |
|---|---|
| id (integer, optional) | ID das informações de pagamento |
| payment_method (string, optional) | Forma de pagamento ('billet' para boleto bancário, 'payment_gateway' para cartão de crédito, 'transfer' para transferência bancária) |
| installments | Quantidade de parcelas para pagamento em cartão de crédito. Valor apenas aceito para ‘payment_method’ como ‘payment_gateway’ (Pode ser igual ou maior que 1; caso seja null, será considerada apenas 1 parcela). Caso o ‘payment_method’ seja ‘billet’ ou ‘transfer’, o valor é null. |
Cria Regra a partir do Modelo de faturamento
Cria uma regra de faturamento a partir de um modelo de faturamento
POST
api/v1/contracts/{contract_id}/invoice_rules
Exemplo de Corpo
{
"invoice_rule": {
"invoice_template_id": 26,
"description": "teste",
"additional_information": {
"title": "Regra nova",
"init_date": "20/12/2018",
"month_quantity": 12
},
"scheduled_updates": [
{
"invoice_template_scheduled_update_id": 490,
"init_date": "20/12/2019",
"month_quantity": 12,
"days_until_update": 7
},
{
"invoice_template_scheduled_update_id": 492,
"init_date": "20/12/2019",
"month_quantity": 12,
"days_until_update": 7
}
]
}
}
Exemplo do retorno
{
"invoice_rule": {
"id": 6955,
"contract_id": 255,
"issue_date": null,
"estimated_issue_date": null,
"gross_value": "95.0",
"payment_value": "95.0",
"description": "teste",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "$DESCRICAO",
"nfe_issued": false,
"number": null,
"created_at": "20/12/2018 13:45:05 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": null,
"customer_id": 16,
"customer_type": "Person",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"notify_customer": false,
"apply_negative_updates": true,
"receivables": [],
"services": [
{
"id": 11563,
"name": "Serviço 1",
"description": "",
"unit_value": "45.0",
"units": "1.0",
"value": "45.0"
},
{
"id": 11564,
"name": "Serviço 7",
"description": "",
"unit_value": "50.0",
"units": "1.0",
"value": "50.0"
}
],
"attachments": [],
"payment_information": {
"id": 7210,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "20/12/2018 13:45:05 -02:00"
},
"additional_information": {
"id": 377,
"init_date": "2018-12-20",
"title": "Regra nova",
"period_unit": "monthly",
"month_quantity": 12,
"end_date": null,
"created_at": "20/12/2018 13:45:05 -02:00",
"accrual_month_quantity": "same_month"
},
"scheduled_updates": [
{
"id": 497,
"invoice_rule_id": 6955,
"execution_date": "2019-12-20",
"month_quantity": 12,
"price_index": "igpdi",
"created_at": "2018-12-20T13:45:05.515-02:00",
"updated_at": "2018-12-20T13:45:05.515-02:00",
"init_date": "2019-12-20",
"days_until_update": 7,
"remind_at": "2019-12-13",
"notified": false,
"service_item_id": 1,
"invoice_template_id": null
},
{
"id": 498,
"invoice_rule_id": 6955,
"execution_date": "2019-12-20",
"month_quantity": 12,
"price_index": "ipcfipe",
"created_at": "2018-12-20T13:45:05.518-02:00",
"updated_at": "2018-12-20T13:45:05.518-02:00",
"init_date": "2019-12-20",
"days_until_update": 7,
"remind_at": "2019-12-13",
"notified": false,
"service_item_id": 7,
"invoice_template_id": null
}
],
"receivables_additional_information": {
"id": 379,
"day_number": 1,
"parcel_number": null,
"invoice_rule_id": 6955,
"created_at": "2018-12-20T13:45:05.520-02:00",
"updated_at": "2018-12-20T13:45:05.520-02:00",
"day_quantity": null,
"month_quantity": null,
"only_business_days": false
}
}
}
Geral
| Campo | Finalidade | Obrigatório |
|---|---|---|
| invoice_template_id | ID do Modelo de faturamento a ser utilizado | Apenas se for criar uma regra usando um modelo |
| additional_information | Informações adicionais da regra | Sim |
| charge_type | Tipo de cobrança nos vencimentos | Apenas se há necessidade de sobrescrever ou completar dados de vencimento no node receivables_additional_information |
1.1 additional_information
| Campo | Finalidade | Obrigatório |
|---|---|---|
| title | Título da regra | Sim |
| init_date | Data de início da regra | Sim |
| end_date | Data de fim da regra | Não. Apenas se a regra não for recorrente (possui fim) |
| month_quantity | Periodicidade da regra | Não. Apenas se for sobrescrever o campo após escolha do modelo |
| accrual_month_quantity | Competência | Não. Apenas se for sobrescrever o campo após escolha do modelo |
1.2 receivables_additional_information
| Campo | Finalidade | Obrigatório |
|---|---|---|
| day_number | Dia do mês para o vencimento | Sim para sobrescrever ou completar escolha do modelo e se charge_type for 'fixed_day' ou 'fixed_day_and_month_quantity' |
| day_quantity | Quantidade de dias para o vencimento | Sim para sobrescrever ou completar escolha do modelo e se charge_type for 'day_quantity' |
| month_quantity | Quantidade de meses para o vencimento | Sim para sobrescrever ou completar escolha do modelo e se charge_type for 'fixed_day_and_month_quantity' |
| parcel_number | Quantidade de parcelas | Sim para sobrescrever ou completar escolha do modelo |
| only_business_days | Considerar apenas dias úteis | Sim para sobrescrever ou completar escolha do modelo e se charge_type for 'day_quantity' ou 'last_day_of_month' |
1.3 services
| Campo | Finalidade | Obrigatório |
|---|---|---|
| service_item_id | ID do serviço para aplicar o reajuste | Não. Apenas se for sobrescrever a escolha no modelo |
| description | Descrição do serviç | Não. Apenas se for sobrescrever a escolha no modelo |
| units | Quantidade | Não. Apenas se for sobrescrever a escolha no modelo |
| unit_value | Valor Unitário | Não. Apenas se for sobrescrever a escolha no modelo |
| invoice_template_service_item_id | ID do serviço presente no modelo escolhido ao qual deverá ocorrer sobrescrita de valores. Este campo representa o campo "id" de cada serviço no modelo | Não. Apenas se for sobrescrever a escolha no modelo |
| _destroy | Excluir serviço | Não. Apenas se for remover um serviço presente no modelo |
1.4 scheduled_updates
| Campo | Finalidade | Obrigatório |
|---|---|---|
| service_item_id | ID do serviço para aplicar o reajuste | Não. Apenas se for sobrescrever escolha no modelo |
| init_date | Data de início do reajuste | Sim. Escolha de modelo com reajuste não atribui data de início |
| month_quantity | Periodicidade do reajuste | Não. Apenas se for sobrescrever escolha no modelo |
| price_index | Índice financeiro para o reajuste | Não. Apenas se for sobrescrever escolha no modelo |
| days_until_update | Quantidade de dias para notificação prévia do reajuste | Não. Apenas se for sobrescrever escolha no modelo |
| _destroy | Excluir reajuste? | Não. Apenas se for remover um reajuste presente no modelo |
| invoice_template_scheduled_update_id | ID do reajuste presente no modelo escolhido ao qual deverá ocorrer sobrescrita de valores. Este campo representa o campo "id" de cada reajuste no modelo | Não. Apenas se for sobrescrever a escolha no modelo |
Lista Regra(s) Faturamento(s)
Lista as regras de faturamento em um contrato
GET
api/v1/contracts/{contract_id}/invoice_rules
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoice_rules": [
{
"id": 184574,
"contract_id": 11986,
"issue_date": null,
"estimated_issue_date": null,
"gross_value": "100.0",
"payment_value": null,
"description": "Regra de faturamento teste para Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe Teste para Regra de Faturamento",
"nfe_issued": false,
"number": null,
"created_at": "10/12/2018 17:03:19 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": null,
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": null,
"finance_category": null,
"finance_revenue_center": null,
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": null,
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": null,
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": null,
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"notify_customer": false,
"apply_negative_updates": false,
"receivables": [],
"services": [
{
"id": 246219,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "1.0",
"value": "100.0"
}
],
"attachments": [],
"payment_information": {
"id": 28410,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 17:03:19 -02:00"
},
"additional_information": {
"id": 7683,
"init_date": "2018-12-01",
"title": "Teste Documentacao",
"period_unit": "monthly",
"month_quantity": 3,
"end_date": null,
"created_at": "10/12/2018 17:03:19 -02:00",
"accrual_month_quantity": "same_month"
},
"scheduled_updates": [
{
"id": 527,
"invoice_rule_id": 184574,
"execution_date": "2018-12-12",
"month_quantity": 3,
"price_index": "ipca",
"created_at": "2018-12-10T17:03:19.193-02:00",
"updated_at": "2018-12-10T17:03:19.193-02:00",
"init_date": "2018-12-12",
"days_until_update": 10,
"remind_at": "2018-12-02",
"notified": false,
"service_item_id": 383
}
],
"receivables_additional_information": {
"id": 7690,
"day_number": 1,
"parcel_number": 1,
"invoice_rule_id": 184574,
"created_at": "2018-12-10T17:03:19.196-02:00",
"updated_at": "2018-12-10T17:03:19.196-02:00",
"day_quantity": null,
"month_quantity": null,
"only_business_days": false
}
},
{
"id": 184573,
"contract_id": 11986,
"issue_date": null,
"estimated_issue_date": null,
"gross_value": "100.0",
"payment_value": null,
"description": "Regra de faturamento teste para Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe Teste para Regra de Faturamento",
"nfe_issued": false,
"number": null,
"created_at": "10/12/2018 16:32:26 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": null,
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": null,
"finance_category": null,
"finance_revenue_center": null,
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": null,
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": null,
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": null,
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"notify_customer": false,
"apply_negative_updates": false,
"receivables": [],
"services": [],
"attachments": [],
"payment_information": {
"id": 28409,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 16:32:26 -02:00"
},
"additional_information": null,
"scheduled_updates": [],
"receivables_additional_information": {
"id": 7689,
"day_number": null,
"parcel_number": null,
"invoice_rule_id": 184573,
"created_at": "2018-12-10T16:32:26.606-02:00",
"updated_at": "2018-12-10T16:32:26.606-02:00",
"day_quantity": null,
"month_quantity": null,
"only_business_days": null
}
},
{
"id": 184572,
"contract_id": 11986,
"issue_date": null,
"estimated_issue_date": null,
"gross_value": "100.0",
"payment_value": null,
"description": "Regra de faturamento teste para Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe Teste para Regra de Faturamento",
"nfe_issued": false,
"number": null,
"created_at": "10/12/2018 16:31:47 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": null,
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": null,
"finance_category": null,
"finance_revenue_center": null,
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": null,
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": null,
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": null,
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"notify_customer": false,
"apply_negative_updates": false,
"receivables": [],
"services": [],
"attachments": [],
"payment_information": {
"id": 28408,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 16:31:47 -02:00"
},
"additional_information": null,
"scheduled_updates": [],
"receivables_additional_information": {
"id": 7688,
"day_number": null,
"parcel_number": null,
"invoice_rule_id": 184572,
"created_at": "2018-12-10T16:31:47.812-02:00",
"updated_at": "2018-12-10T16:31:47.812-02:00",
"day_quantity": null,
"month_quantity": null,
"only_business_days": null
}
},
{
"id": 184521,
"contract_id": 11986,
"issue_date": null,
"estimated_issue_date": null,
"gross_value": "700.0",
"payment_value": null,
"description": "teste",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "$DESCRICAO",
"nfe_issued": false,
"number": null,
"created_at": "10/12/2018 10:02:38 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": null,
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"notify_customer": false,
"apply_negative_updates": false,
"receivables": [],
"services": [
{
"id": 246189,
"name": "Serviço Teste Doc",
"description": "Serviço criado para testes internos da documentação",
"unit_value": "700.0",
"units": "1.0",
"value": "700.0"
}
],
"attachments": [],
"payment_information": {
"id": 28378,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 10:02:38 -02:00"
},
"additional_information": {
"id": 7682,
"init_date": "2018-12-10",
"title": "Regra de Fat Teste",
"period_unit": "monthly",
"month_quantity": 1,
"end_date": "2019-12-31",
"created_at": "10/12/2018 10:02:38 -02:00",
"accrual_month_quantity": "same_month"
},
"scheduled_updates": [],
"receivables_additional_information": {
"id": 7687,
"day_number": 3,
"parcel_number": null,
"invoice_rule_id": 184521,
"created_at": "2018-12-10T10:02:38.824-02:00",
"updated_at": "2018-12-10T10:02:38.824-02:00",
"day_quantity": null,
"month_quantity": null,
"only_business_days": false
}
}
]
}
Atualiza Regra Faturamento
Atualiza uma regra de faturamento
PATCH
api/v1/contracts/{contract_id}/invoice_rules/{id}
O corpo da requisição deverá conter somente o(s) campo(s) que deseja(m) ser atualizado(s), tomando como base a mesma estrutura de criação.
Exemplo de Corpo
{
"invoice_rule":
{
"description": "Edição da Regra de faturamento teste para Doc"
}
}
Exemplo do retorno
{
"invoice_rule": {
"id": 184574,
"contract_id": 11986,
"issue_date": null,
"estimated_issue_date": null,
"gross_value": "100.0",
"payment_value": null,
"description": "Edição da Regra de faturamento teste para Doc",
"state": "to_emit",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Nfe Teste para Regra de Faturamento",
"nfe_issued": false,
"number": null,
"created_at": "10/12/2018 17:03:19 -02:00",
"management_type": "manual",
"accrual_date": null,
"comments": null,
"customer_id": 1954,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": null,
"finance_category": null,
"finance_revenue_center": null,
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": null,
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": null,
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": null,
"days_until_automatic_nfe_emission": 0,
"automatic_nfe_issue_date": null,
"automatic_email_template_id": null,
"approval_status": "approved",
"notification_ruler_id": null,
"notify_customer": false,
"apply_negative_updates": false,
"receivables": [],
"services": [
{
"id": 246219,
"name": "Serviço Teste Doc",
"description": "Teste",
"unit_value": "100.0",
"units": "1.0",
"value": "100.0"
}
],
"attachments": [],
"payment_information": {
"id": 28410,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"created_at": "10/12/2018 17:03:19 -02:00"
},
"additional_information": {
"id": 7683,
"init_date": "2018-12-01",
"title": "Teste Documentacao",
"period_unit": "monthly",
"month_quantity": 3,
"end_date": null,
"created_at": "10/12/2018 17:03:19 -02:00",
"accrual_month_quantity": "same_month"
},
"scheduled_updates": [
{
"id": 527,
"invoice_rule_id": 184574,
"execution_date": "2018-12-12",
"month_quantity": 3,
"price_index": "ipca",
"created_at": "2018-12-10T17:03:19.193-02:00",
"updated_at": "2018-12-11T00:00:35.064-02:00",
"init_date": "2018-12-12",
"days_until_update": 10,
"remind_at": "2018-12-02",
"notified": true,
"service_item_id": 383
}
],
"receivables_additional_information": {
"id": 7690,
"day_number": 1,
"parcel_number": 1,
"invoice_rule_id": 184574,
"created_at": "2018-12-10T17:03:19.196-02:00",
"updated_at": "2018-12-10T17:03:19.196-02:00",
"day_quantity": null,
"month_quantity": null,
"only_business_days": false
}
}
}
Exclui Regra Faturamento
Excluir uma regra de faturamento
DELETE
api/v1/contracts/{contract_id}/invoice_rules/{id}
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
"Não há conteudo de retorno ao deletar"
HTTP Status Code
| Code | Observações |
|---|---|
| 200 | Encontrado |
| 400 | Bad Request |
| 401 | Não Autorizado |
| 404 | Não Encontrado |
| 422 | Entidade não processável |
Modelos de faturamento
Detalhes Modelo de Faturamento
Mostra os detalhes de um Modelo de Faturamento
GET
api/v1/organizations/{organizations_id}/invoice_templates/{id}
Exemplo de chamada: api/v1/organizations/1/invoice_templates/14
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoice_template": {
"id": 14,
"name": "Modelo completo",
"gross_value": "64.28",
"month_quantity": 12,
"period_unit": "monthly",
"management_type": "automatic",
"automatic_email_template_id": 1,
"notification_ruler_id": 57,
"accrual_month_quantity": "previous_month",
"description": "teste",
"receivables_additional_information": {
"charge_type": "fixed_day_and_month_quantity",
"day_number": 12,
"day_quantity": null,
"month_quantity": 3,
"parcel_number": 4,
"only_business_days": null,
"create_parcels": true
},
"emites_service_values_id": 65,
"emites_service_value_name": "Aluguel de software com retenção de ISS",
"days_until_automatic_nfe_emission": 7,
"nfe_body": "$DESCRICAO",
"payment_method": "payment_gateway",
"card_installments": 12,
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": 36,
"myfinance_sale_account_name": "Cielo",
"notify_customer": true,
"apply_negative_updates": true,
"created_at": "14/12/2018 16:54:47 -02:00",
"services": [
{
"id": 11210,
"name": "Serviço 1",
"description": "",
"unit_value": "5.75",
"units": "2.5",
"value": "14.38"
},
{
"id": 11209,
"name": "App",
"description": "",
"unit_value": "49.9",
"units": "1.0",
"value": "49.9"
}
],
"scheduled_updates": [
{
"id": 475,
"invoice_rule_id": null,
"execution_date": null,
"month_quantity": 12,
"price_index": "igpm",
"created_at": "2018-12-19T16:37:21.573-02:00",
"updated_at": "2018-12-19T16:51:16.715-02:00",
"init_date": null,
"days_until_update": null,
"remind_at": null,
"notified": false,
"service_item_id": 1,
"invoice_template_id": 14
},
{
"id": 481,
"invoice_rule_id": null,
"execution_date": null,
"month_quantity": null,
"price_index": "igpdi",
"created_at": "2018-12-19T16:51:16.718-02:00",
"updated_at": "2018-12-19T16:51:16.718-02:00",
"init_date": null,
"days_until_update": 7,
"remind_at": null,
"notified": false,
"service_item_id": 11,
"invoice_template_id": 14
}
]
}
}
Campos node Invoice Template
| Campo | Finalidade |
|---|---|
| name (string) | Nome do Modelo |
| gross_value (string) | Valor bruto de cada faturamento |
| month_quantity (integer) | Periodicidade de Cobrança 1-mensalmente 2-bimestralmente 3-trimestralmente 6-semestralmente 12-anualmente |
| period_unit (string, optional) | Base de periodicidade para criação de faturamentos: 'weekly' para base semanal ou 'monthly' para base mensal |
| management_type (string, optional) | Tipo de Faturamento. (Opções: 'manual' ou 'automatic') |
| automatic_email_template_id (integer, optional) | ID do Modelo de Notificação Automática (obrigatório para faturamentos automáticos) |
| notification_ruler_id (integer, optional) | ID da Régua de Cobrança para os faturamentos da regra |
| accrual_month_quantity (string) | Competência do faturamento (same_month => No mesmo mês da data do faturamento / previous_month => No mês anterior à data do faturamento) |
| description (string, optional) | Descrição |
| emites_service_values_id (integer, optional) | ID do Modelo de NFS-e (Emites) |
| emites_service_value_name (string, optional) | Nome do Modelo de NFS-e (Emites) |
| days_until_automatic_nfe_emission (integer, optional) | Quantidade de dias úteis após o recebimento para emissão automática de NF-e (0 para emissão na data do faturamento) |
| nfe_body (string) | Corpo da NFS-e |
| payment_method (string, optional) | Forma de pagamento ('billet' para boleto bancário, 'payment_gateway' para cartão de crédito, 'transfer' para transferência bancária) |
| card_installments | Quantidade de parcelas para pagamento em cartão de crédito. Caso o ‘payment_method’ seja ‘billet’ ou ‘transfer’, o valor é null. |
| cobrato_charge_config_id (integer, optional) | ID da Configuração de Cobrança (Cobrato) |
| cobrato_charge_config_name (string, optional) | Nome da Configuração de Cobrança (Cobrato) |
| cobrato_charge_template_id (integer, optional) | ID do Modelo de Cobrança (Cobrato) |
| cobrato_charge_template_name (string, optional) | Nome do Modelo de Cobrança (Cobrato) |
| finance_category (string, optional) | Categoria |
| finance_revenue_center (string, optional) | Centro de Receita |
| myfinance_sale_account_id (integer, optional) | ID da Conta de Recebível (obrigatório para criação de recebível no Myfinance) |
| myfinance_sale_account_name (string, optional) | Nome da Conta de Recebível (obrigatório para criação de recebível no Myfinance) |
| notify_customer (boolean, optional) | Notificar o cliente via e-mail sobre o(s) reajuste(s) |
| apply_negative_updates (boolean, optional) | Permitir reajuste(s) negativo(s) |
Campos node receivables_additional_information
Configurações das informações adicionais sobre contas a receber
| Campo | Finalidade |
|---|---|
| charge_type (string) | Tipo da cobrança dos vencimentos. (fixed_day => No próximo dia x após a data do faturamento / last_day_of_month => No último dia do mês após a data do faturamento / day_quantity => Após x dias da data do faturamento / fixed_day_and_month_quantity => No dia x após x mes(es) da data do faturamento |
| day_number (integer, optional) | Dia do mês do vencimento. (se charge_type for fixed_day ou fixed_day_and_month_quantity) |
| day_quantity (integer, optional) | Quantidade de dias para o vencimento (se charge_type for day_quantity) |
| month_quantity (integer, optional) | Quantidade de meses para o vencimento. (Se charge_type for fixed_day_and_month_quantity) |
| parcel_number (integer, optional) | Número de parcelas do vencimento |
| only_business_days (boolean, optional) | Considerar apenas dias úteis (se charge_type for day_quantity ou last_day_of_month) |
| create_parcels (boolean, optional) | Cria parcelas? |
Campos node services
Configurações de Serviços (Array)
| Campo | Finalidade |
|---|---|
| id | Id do serviço |
| name | Name do serviço |
| description | Descrição do serviço |
| unit_value | Valor Unitário |
| units | Quantidade |
| value | Valor |
Campos node scheduled_updates
Configurações de reajuste automático (Array)
| Campo | Finalidade |
|---|---|
| id (integer) | Id do reajuste automático |
| invoice_rule_id (integer) | Id da Regra de faturamento - Sempre será null |
| execution_date (date) | Data da execução - sempre será null |
| month_quantity (integer) | Periodicidade mensal do reajuste |
| price_index (string) | Índice financeiro para o reajuste (igpm, ipca, igpdi, inpc ou ipcfipe) |
| created_at (datetime) | Data de criação do scheduled_update |
| updated_at (datetime) | Data de alteração do scheduled_update |
| init_date (date) | Data de início do reajuste |
| days_until_update (integer) | Quantidade de dias para notificação antes do reajuste - |
| remind_at | Data de lembrate - sempre será null |
| notified | Flag de notificação - sempre será null |
| service_item_id | Id do item de serviço |
| invoice_template_id | Id do modelo da faturamento |
Lista Modelo de Faturamento(s)
Lista os modelos de faturamento(s)
GET
api/v1/organizations/{organizations_id}/invoice_templates
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"invoice_templates": [
{
"id": 3,
"name": "Modelo 1",
"gross_value": "500.0",
"month_quantity": 3,
"period_unit": "monthly",
"management_type": "automatic",
"automatic_email_template_id": 1,
"notification_ruler_id": null,
"accrual_month_quantity": "same_month",
"description": "teste",
"receivables_additional_information": {
"charge_type": "day_quantity",
"day_number": null,
"day_quantity": null,
"month_quantity": null,
"parcel_number": null,
"only_business_days": true,
"create_parcels": true
},
"emites_service_values_id": null,
"emites_service_value_name": "",
"days_until_automatic_nfe_emission": 0,
"nfe_body": "$DESCRICAO",
"payment_method": "payment_gateway",
"card_installments": 12,
"cobrato_charge_config_id": 137,
"cobrato_charge_config_name": "Teste Cartão",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": null,
"myfinance_sale_account_name": "",
"notify_customer": false,
"apply_negative_updates": false,
"created_at": "11/12/2018 08:50:37 -02:00",
"services": [
{
"id": 11198,
"name": "Serviço 1",
"description": "",
"unit_value": "250.0",
"units": "2.0",
"value": "500.0"
}
],
"scheduled_updates": []
},
{
"id": 14,
"name": "Modelo completo",
"gross_value": "64.28",
"month_quantity": 12,
"period_unit": "monthly",
"management_type": "automatic",
"automatic_email_template_id": 1,
"notification_ruler_id": 57,
"accrual_month_quantity": "previous_month",
"description": "teste",
"receivables_additional_information": {
"charge_type": "fixed_day_and_month_quantity",
"day_number": 12,
"day_quantity": null,
"month_quantity": 3,
"parcel_number": 4,
"only_business_days": null,
"create_parcels": true
},
"emites_service_values_id": 65,
"emites_service_value_name": "Aluguel de software com retenção de ISS",
"days_until_automatic_nfe_emission": 7,
"nfe_body": "$DESCRICAO",
"payment_method": "payment_gateway",
"card_installments": 12,
"cobrato_charge_config_id": null,
"cobrato_charge_config_name": "",
"cobrato_charge_template_id": null,
"cobrato_charge_template_name": "",
"finance_category": "",
"finance_revenue_center": "",
"myfinance_sale_account_id": 36,
"myfinance_sale_account_name": "Cielo",
"notify_customer": true,
"apply_negative_updates": true,
"created_at": "14/12/2018 16:54:47 -02:00",
"services": [
{
"id": 11210,
"name": "Serviço 1",
"description": "",
"unit_value": "5.75",
"units": "2.5",
"value": "14.38"
},
{
"id": 11209,
"name": "App",
"description": "",
"unit_value": "49.9",
"units": "1.0",
"value": "49.9"
}
],
"scheduled_updates": [
{
"id": 475,
"invoice_rule_id": null,
"execution_date": null,
"month_quantity": 12,
"price_index": "igpm",
"created_at": "2018-12-19T16:37:21.573-02:00",
"updated_at": "2018-12-19T16:51:16.715-02:00",
"init_date": null,
"days_until_update": null,
"remind_at": null,
"notified": false,
"service_item_id": 1,
"invoice_template_id": 14
},
{
"id": 481,
"invoice_rule_id": null,
"execution_date": null,
"month_quantity": null,
"price_index": "igpdi",
"created_at": "2018-12-19T16:51:16.718-02:00",
"updated_at": "2018-12-19T16:51:16.718-02:00",
"init_date": null,
"days_until_update": 7,
"remind_at": null,
"notified": false,
"service_item_id": 11,
"invoice_template_id": 14
}
]
}
]
}
Notificações
Lista Notificações
Lista todas as notificações de uma organização
GET
api/v1/organizations/{organization_id}/email_templates
Exemplo: api/v1/organizations/2115/email_templates
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"email_templates": [
{
"id": 3,
"company_id": 1,
"name": "Notificação de Teste",
"cc": "",
"from": "",
"body": "Foo Bar Zaz",
"subject": "Notificação de Teste",
"description": "Descrição",
"include_billet": true,
"include_nfse_pdf": false,
"include_nfse_xml": false,
"include_attachments": false,
"include_invoice_pdf": false,
"default_template": false,
"subscription_default_template": false,
"created_at": "11/02/2019 09:30:44 -03:00"
},
{
"id": 2,
"company_id": 1,
"name": "Notificação padrão para assinaturas",
"cc": null,
"from": null,
"body": "Prezado Cliente",
"subject": "Assinatura do plano $PLANO",
"description": "Notifica o cliente sobre cobrança em assinatura.",
"include_billet": true,
"include_nfse_pdf": false,
"include_nfse_xml": false,
"include_attachments": false,
"include_invoice_pdf": false,
"default_template": false,
"subscription_default_template": true,
"created_at": "11/02/2019 09:03:28 -03:00"
}
]
}
Modelos de Nota Fiscal
Lista Modelos de Nota Fiscal
Lista todos os modelos de nota fiscal de uma organização
GET
api/v1/organizations/{organization_id}/nfse_templates
Exemplo: api/v1/organizations/2115/nfse_templates
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"nfse_templates": [
{
"id": 6,
"company_id": 2115,
"name": "Exemplo de Modelo de Nota Fiscal",
"codigo_servico_municipal": "010501",
"item_lista_servico": "0105",
"cnae": "6201501",
"servico_prestado_municipio_cliente": false,
"iss_retido_fonte": false,
"aliquota_iss": "5.0",
"aliquota_ir": "1.5",
"aliquota_pis": "0.65",
"aliquota_cofins": "3.0",
"aliquota_csll": "1.0",
"aliquota_inss": "10.0",
"aliquota_iss_retido": "5.0",
"retencoes_destacadas_nota": [
"IR",
"PIS",
"COFINS",
"CSLL",
"INSS",
"ISS"
],
"percentual_carga_tributaria": "13.15",
"fonte_carga_tributaria": "IBPT",
"limite_retencao_ir": "666.67",
"limite_retencao_pcc": "215.06",
"limite_retencao_inss": "1000.0",
"limite_retencao_iss": "500.0",
"created_at": "2020-11-25T14:29:02.532-03:00",
"updated_at": "2020-11-30T16:27:15.929-03:00",
"external_service_id": "",
"external_service_description": ""
},
{
"id": 7,
"company_id": 2115,
"name": "Exemplo de Modelo de Nota Fiscal (PF)",
"codigo_servico_municipal": "010501",
"item_lista_servico": "01.05",
"cnae": "",
"servico_prestado_municipio_cliente": true,
"iss_retido_fonte": false,
"aliquota_iss": null,
"aliquota_ir": null,
"aliquota_pis": null,
"aliquota_cofins": null,
"aliquota_csll": null,
"aliquota_inss": null,
"aliquota_iss_retido": null,
"retencoes_destacadas_nota": [],
"percentual_carga_tributaria": "0.0",
"fonte_carga_tributaria": "",
"limite_retencao_ir": "666.67",
"limite_retencao_pcc": "215.06",
"limite_retencao_inss": "1000.0",
"limite_retencao_iss": "500.0",
"created_at": "2020-11-26T14:29:02.532-03:00",
"updated_at": "2020-11-30T16:27:15.929-03:00",
"external_service_id": "",
"external_service_description": ""
}
]
}