Fintera Faturamento API v1.0.0
Introduçã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 Fintera Faturamento.
O Fintera Faturamento 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 Fintera Faturamento. 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 https://faturamento.fintera.com.br/api/v1/companies \
-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 Fintera Faturamento, 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 |
Webhooks
Fintera Faturamento envia webhooks para notificar diversos eventos ocorridos na aplicação.
Teste
Evento: --
Objeto: --
Descrição: Quando uma URL é cadastrada e antes de todo envio de webhook para teste de disponibilidade da URL cadastrada
POST
Exemplo de Corpo
{
"test":true
}
Update
Evento: update
Objeto: Invoice
Descrição: Quando o faturamento é atualizado
POST
Exemplo de Corpo
{
"event": "update",
"object_type": "Invoice",
"object_id": "id-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Emit
Evento: emit
Objeto: Invoice
Descrição: Quando o faturamento é marcado como faturado
POST
Exemplo de Corpo
{
"event": "emit",
"object_type": "Invoice",
"object_id": "id-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Undo_emission
Evento: undo_emission
Objeto: Invoice
Descrição: Quando o faturamento é marcado como a faturar
POST
Exemplo de Corpo
{
"event": "undo_emission",
"object_type": "Invoice",
"object_id": "id-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Cancel
Evento: cancel
Objeto: Invoice
Descrição: Quando o faturamento é cancelado
POST
Exemplo de Corpo
{
"event": "cancel",
"object_type": "Invoice",
"object_id": "id-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Undo_cancellation
Evento: undo_cancellation
Objeto: Invoice
Descrição: Quando é desfeito o cancelamento do faturamento
POST
Exemplo de Corpo
{
"event": "undo_cancellation",
"object_type": "Invoice",
"object_id": "id-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Confirm_receival
Evento: confirm_receival
Objeto: Invoice
Descrição: Quando é confirmado o recebimento do faturamento
POST
Exemplo de Corpo
{
"event": "confirm_receival",
"object_type": "Invoice",
"object_id": "id-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Undo_receival
Evento: undo_receival
Objeto: Invoice
Descrição: Quando é desfeito o recebimento do faturamento
POST
Exemplo de Corpo
{
"event": "undo_receival",
"object_type": "Invoice",
"object_id": "id-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Receivement_error
Evento: receivement_error
Objeto: Invoice
Descrição: 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-do-objeto",
"contract_token": "token-do-contrato",
"contract_id": "id-do-contrato"
}
Change_plan
Evento: change_plan
Objeto: Contract
Descrição: 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,
"nfse_email": null,
"myfinance_customer_id": null,
"myfinance_errors": null,
"created_at": "03/12/2018 12:35:54 -02:00",
"updated_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 |
| nfse_email (string, optional) | E-mail para nota fiscal |
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,
"nfse_email": "teste@teste.com.br",
"myfinance_customer_id": 213341,
"myfinance_errors": null,
"created_at": "10/12/2018 15:26:12 -02:00",
"updated_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,
"nfse_email": null,
"myfinance_customer_id": 2240155,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00",
"updated_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,
"nfse_email": "teste@teste.com.br",
"myfinance_customer_id": 2306837,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00",
"updated_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,
"nfse_email": null,
"myfinance_customer_id": 2245885,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00",
"updated_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,
"nfse_email": "teste@teste.com.br",
"myfinance_customer_id": 2240155,
"myfinance_errors": null,
"created_at": "28/04/2018 11:41:53 -03:00",
"updated_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,
"nfse_email": null,
"myfinance_customer_id": 2411787,
"myfinance_errors": null,
"created_at": "03/12/2018 12:35:54 -02:00",
"updated_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",
"allow_email_on_nfse": true
}
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,
"allow_email_on_nfse": true,
"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 |
| allow_email_on_nfse (boolean, optional) | Informa e-mail para a nota fiscal |
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,
"allow_email_on_nfse": false,
"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",
"allow_email_on_nfse": false,
"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",
"allow_email_on_nfse": true,
"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",
"allow_email_on_nfse": false,
"myfinance_customer_id": 1693842,
"myfinance_errors": null,
"created_at": "21/09/2016 22:33:32 -03:00"
}
]
}
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,
"allow_email_on_nfse": false,
"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,
"allow_email_on_nfse": false,
"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ço
GET
api/v1/service_items/search?name=Teste%20Doc
Onde name=Teste%20Doc deverá conter o nome do serviço desejado
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 |
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 contrato
GET
api/v1/contracts/search?name=teste&customer_id=11984
Onde "teste" deverá ser o nome do seu contrato, e customer_id se refere ao ID do cliente
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"
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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": false,
"comments": 0,
"invoice_template_id" : 1,
"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",
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": null
}
}
}
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": null,
"finance_category": "",
"finance_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": false,
"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,
"myfinance_receivable_account_id": 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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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_category_id (integer, optional) | ID de Categoria |
| finance_revenue_center (string, optional) | Centro de Receita |
| finance_revenue_center_id (integer, optional) | ID de Centro de Receita |
| myfinance_sale_account_id (integer, optional) | ID da Conta de Recebível (obrig p/ criação de recebível no Fintera Financeiro) |
| myfinance_sale_account_name (string, optional) | Nome da Conta de Recebível (obrig p/ criação criação de recebível no Fintera Financeiro) |
| 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 |
| issue_nfse (boolean, optional) | Emitir nota fiscal |
| invoice_template_id (integer, optional) | ID do modelo de faturamento (É obrigatório ter periodicidade "uma única vez") |
- 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. |
| financial_charge_template_id (integer, optional) | ID do modelo de cobrança |
| financial_account_id (integer, optional) | ID da conta de recebimento |
| charging_account_id (string, optional) | UUID da carteira de cobrança |
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": null,
"finance_category": "",
"finance_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": false,
"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.",
"myfinance_receivable_account_id": 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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": null,
"created_at": "10/12/2018 10:55:10 -02:00"
}
}
}
Atualiza Faturamento
Atualiza um faturamento
PATCH
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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": true,
"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.",
"myfinance_receivable_account_id": null
}
],
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": null,
"created_at": "10/12/2018 11:36:23 -02:00"
}
}
}
Busca Faturamentos
Realiza busca de faturamentos por organização com base nos filtros especificados.
GET
api/v1/organizations/{organization_id}/invoices/search?q[state_eq]=received&q[issue_date_gteq]=01-04-2018&q[issue_date_lteq]=31-12-2018&page=1&per_page=50
No exemplo acima é retornada a primeira página(page=1), contendo 50 faturamentos por página(per_page=50), que já foram recebidos(state=received) e a data de faturamento esteja entre 01/04/2018 e 31/12/2018
per_page tem como características:
- default: 50
- valor máximo: 100
state pode ter os seguintes valores:
- to_emit: faturamentos a faturar
- to_receive: faturamentos a receber
- received: faturamentos recebidos
- cancelled: faturamentos cancelados
- late: faturamentos inadimplentes
Filtros disponíveis para busca
| q[issue_date_gteq] | date | Data de faturamento maior que |
| q[issue_date_lteq] | date | Data de faturamento menor que |
| q[receivables_due_date_gteq] | date | Data de vencimento maior que |
| q[receivables_due_date_lteq] | date | Data de vencimento menor que |
| q[state_eq] | string | Status igual a |
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"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": "received",
"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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": true,
"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.",
"myfinance_receivable_account_id": null
}
],
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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": "rceived",
"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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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.",
"myfinance_receivable_account_id": null
}
],
"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,
"financial_charge_template_id": null,
"financial_account_id": null,
"charging_account_id": "52aaaaaa-51ee-41dd-af55-cd0000000000",
"created_at": "10/12/2018 10:02:39 -02:00"
}
}
]
}
Busca Faturamentos Por Contrato
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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": true,
"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.",
"myfinance_receivable_account_id": null
}
],
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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.",
"myfinance_receivable_account_id": null
}
],
"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,
"financial_charge_template_id": null,
"financial_account_id": null,
"charging_account_id": "52aaaaaa-51ee-41dd-af55-cd0000000000",
"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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": true,
"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.",
"myfinance_receivable_account_id": null
}
],
"services": [],
"attachments": [],
"payment_information": {
"id": 24323,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"financial_charge_template_id": null,
"financial_account_id": null,
"charging_account_id": 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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": true,
"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.",
"myfinance_receivable_account_id": null
}
],
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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,
"issue_nfse": true,
"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.",
"myfinance_receivable_account_id": null
}
],
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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",
"issue_nfse": true,
"nfse_template_id": 2275,
"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",
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": null
}
}
}
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,
"nfse_template_id": 2275,
"finance_category": null,
"finance_category_id": null,
"finance_revenue_center": null,
"finance_revenue_center_id": 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,
"issue_nfse": true,
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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_category_id (integer, optional) | ID de Categoria |
| finance_revenue_center (string, optional) | Centro de Receita |
| finance_revenue_center_id (integer, optional) | ID de Centro de Receita |
| myfinance_sale_account_id (integer, optional) | ID da Conta de Recebível (obrigatório para criação de recebível no Fintera Financeiro) |
| myfinance_sale_account_name (string, optional) | Nome da Conta de Recebível (obrigatório para criação de recebível no Fintera Financeiro) |
| 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 |
| issue_nfse (boolean, optional) | Emitir nota fiscal |
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 / next_month => No mês seguinte à 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. |
| financial_charge_template_id (integer, optional) | ID do modelo de cobrança |
| financial_account_id (integer, optional) | ID da conta de recebimento |
| charging_account_id (string, optional) | UUID da carteira de cobrança |
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",
"issue_nfse": true,
"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": "",
"nfse_template_id": null,
"finance_category": "",
"finance_category_id": null,
"finance_revenue_center": "",
"finance_revenue_center_id": null,
"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": [],
"issue_nfse": true,
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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 (Não pode ter periodicidade "uma única vez") | 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,
"nfse_template_id": null,
"finance_category": null,
"finance_category_id": null,
"finance_revenue_center": null,
"finance_revenue_center_id": 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,
"issue_nfse": true,
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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,
"nfse_template_id": null,
"finance_category": null,
"finance_category_id": null,
"finance_revenue_center": null,
"finance_revenue_center_id": 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,
"issue_nfse": true,
"receivables": [],
"services": [],
"attachments": [],
"payment_information": {
"id": 28409,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"financial_charge_template_id": null,
"financial_account_id": null,
"charging_account_id": "52aaaaaa-51ee-41dd-af55-cd0000000000",
"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,
"nfse_template_id": 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,
"issue_nfse": false,
"receivables": [],
"services": [],
"attachments": [],
"payment_information": {
"id": 28408,
"payment_method": "billet",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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": "",
"nfse_template_id": null,
"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,
"issue_nfse": true,
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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,
"nfse_template_id": null,
"finance_category": null,
"finance_category_id": null,
"finance_revenue_center": null,
"finance_revenue_center_id": 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,
"issue_nfse": true,
"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,
"financial_charge_template_id": 2,
"financial_account_id": 51,
"charging_account_id": 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": 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": 36,
"myfinance_sale_account_name": "Cielo",
"notify_customer": true,
"apply_negative_updates": true,
"created_at": "14/12/2018 16:54:47 -02:00",
"issue_nfse": true,
"financial_account_id": null,
"charging_account_id": null,
"financial_charge_template_id": null,
"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 / next_month => No mês seguinte à 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. |
| financial_account_id (integer, optional) | ID da conta de recebimento |
| financial_charge_template_id (integer, optional) | ID do modelo de cobrança |
| charging_account_id (string, optional) | UUID da carteira de cobrança |
| 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 Fintera Financeiro) |
| myfinance_sale_account_name (string, optional) | Nome da Conta de Recebível (obrigatório para criação de recebível no Fintera Financeiro) |
| 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) |
| issue_nfse (boolean, optional) | Emitir nota fiscal |
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",
"issue_nfse": false,
"financial_account_id": null,
"charging_account_id": null,
"financial_charge_template_id": null,
"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": "pjbank",
"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",
"issue_nfse": true,
"financial_account_id": 123,
"charging_account_id": null,
"financial_charge_template_id": 321,
"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
}
]
}
]
}
Buscar Modelo de Faturamentos
Realiza busca de modelos de faturamento por organização, de acordo com o tipo para o qual ele é usado.
GET
api/v1/organizations/{organizations_id}/invoice_templates/search?type=invoice_rule
Onde type pode ter dois valores:
- invoice: quando se busca por modelos que podem ser usados em faturamentos
- invoice_rule: quando se busca por modelos que podem ser usados em regras de faturamento
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/2022 08:50:37 -02:00",
"issue_nfse": false,
"financial_account_id": null,
"charging_account_id": null,
"financial_charge_template_id": null,
"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": "pjbank",
"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/2022 16:54:47 -02:00",
"issue_nfse": true,
"financial_account_id": 123,
"charging_account_id": null,
"financial_charge_template_id": 321,
"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": "2022-05-25T16:37:21.573-02:00",
"updated_at": "2022-05-25T16: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": "2022-05-25T16:51:16.718-02:00",
"updated_at": "2022-05-25T16: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
}
]
}
]
}
Recebimentos
Buscar Recebimentos
Realiza busca de recebimentos por contrato, para o período e status especificado.
GET
api/v1/contracts/{contract_id}/receivables/search?due_date_from=01-01-2022&due_date_to=31-12-2022&state=to_emit
Onde deseja que o recebimento esteja entre as datas 01/01/2022 a 31/12/2022 e state pode ter os seguintes valores:
- to_emit: recebimentos a faturar
- to_receive: recebimentos a receber
- received: recebimentos recebidos
- cancelled: recebimentos cancelados
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"receivables": [
{
"id": 376,
"invoice_id": 381,
"due_date": "01/01/2023",
"value": "100.0",
"gross_value": "1.0",
"payment_value": "1.0",
"received_value": null,
"received_at": null,
"created_at": "28/12/2022 09:23:56 -03: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,
"myfinance_receivable_account_id": null,
"boleto_url": null,
"invoice": {
"id": 381,
"contract_id": 19,
"issue_date": "28/12/2022",
"estimated_issue_date": "28/12/2022",
"gross_value": "1.0",
"payment_value": "1.0",
"description": "1",
"state": "received",
"cancelled_automatically": false,
"nfe_service": null,
"nfe_verification": null,
"nfe_issue_date": null,
"nfe_body": "Teste de busca de recebiveis",
"nfe_issued": false,
"number": null,
"created_at": "28/12/2022 09:23:56 -03:00",
"management_type": "automatic",
"accrual_date": "2022-12-01",
"comments": null,
"customer_id": 17,
"customer_type": "Company",
"emites_service_values_id": null,
"emites_service_value_name": null,
"nfse_template_id": 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": "28/12/2022",
"automatic_email_template_id": 43,
"approval_status": "approved",
"notification_ruler_id": null,
"issue_nfse": true,
"services": [],
"attachments": [],
"payment_information": {
"id": 464,
"payment_method": "transfer",
"cobrato_card_id": "--",
"card_expiration_month": "--",
"card_expiration_year": "--",
"installments": null,
"financial_charge_template_id": null,
"financial_account_id": null,
"charging_account_id": null,
"created_at": "28/12/2022 09:23:56 -03:00"
},
"fatura_url": "http://faturamento.fintera.com.br/files/c2d18b65-9ad7-4340-a01c-07a5c93f27db.pdf",
"nfse_url": null,
}
}
]
}
Confirmar recebimento
Atualiza a situação do recebimento para recebida.
PATCH
api/v1/contracts/{contract_id}/receivables/{receivable_id}/receive
Exemplo de Corpo
{
"receivable": {
"received_value": 50.00,
"received_at": "30/10/2024"
}
}
Exemplo do retorno
{
"receivable": {
"id": 1,
"invoice_id": 1,
"due_date": "29/10/2024",
"value": "50.0",
"gross_value": "50.0",
"payment_value": "50.0",
"received_value": "50.0",
"received_at": "30/10/2024",
"created_at": "29/10/2024 17:54:53 -03:00",
"state": "received",
"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,
"myfinance_receivable_account_id": null
}
}
Desfazer recebimento
Atualiza a situação do recebimento para a receber.
PATCH
api/v1/contracts/{contract_id}/receivables/{receivable_id}/undo_receipt
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"receivable": {
"id": 1,
"invoice_id": 1,
"due_date": "29/10/2024",
"value": "50.0",
"gross_value": "50.0",
"payment_value": "50.0",
"received_value": "50.0",
"received_at": "30/10/2024",
"created_at": "29/10/2024 17:54:53 -03:00",
"state": "to_receive",
"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,
"myfinance_receivable_account_id": null
}
}
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"
}
]
}
Notas Fiscais
Busca Notas Fiscais
Realiza busca de notas fiscais de uma organização com base nos filtros especificados.
GET
api/v1/organizations/{organization_id}/nfses/search?{filtros}
per_page tem como características:
- default: 50
- valor máximo: 100
status pode ter os seguintes valores:
- 1: Emitida
- 2: Cancelada
- 4: Cancelando
- 6: Erro no cancelamento
Exemplos de filtros para busca
| q[*_eq] | Igual | q[status_eq]=1 |
| q[*_not_eq] | Diferente | q[status_not_eq]=2 |
| q[*_gteq] | Maior ou igual | q[generated_at_gteq]=05/08/2024 |
| q[*_lteq] | Menor ou igual | q[generated_at_lteq]=05/08/2024 |
| q[*_in] | Corresponder a quaisquer valores na matriz | q[id_in][]=1010&q[id_in][]=1011 |
| q[*_not_in] | Não corresponde a nenhum valor na matriz | q[id_not_in][]=1010&q[id_not_in][]=1011 |
Exemplo: api/v1/organizations/2115/nfses/search?q[status]=1&q[generated_at_gteq]=05/08/2024&q[generated_at_lteq]=18/08/2024&page=1&per_page=50
No exemplo acima é retornada a primeira página (page=1), contendo 50 notas fiscais por página (per_page=50), que estão com status igual a emitida (status=1) e a data da emissão esteja entre 05/08/2024 e 18/08/2024
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"nfses": [
{
"id": 1,
"nfse_number": "3200",
"generated_at": "05/08/2024 01:00:32 -03:00",
"value": "10.0",
"verification_code": "LDCE-BCXB",
"city_nfse_url": null,
"status": "Emitida",
"invoice_id": 62,
"customer_type": "Company",
"customer_id": 2,
"created_at": "05/08/2024 11:37:37 -03:00",
"updated_at": "05/08/2024 11:40:23 -03:00",
"external_id": "3f90b87d-1a8a-4c32-bddf-cf222f330932",
"servico_prestado_municipio_cliente": false,
"iss_retido_fonte": false,
"percentual_carga_tributaria": "0.0",
"carga_tributaria_value": "0.0",
"fonte_carga_tributaria": "",
"ir_value": "0.0",
"pis_value": "0.0",
"cofins_value": "0.0",
"csll_value": "0.0",
"inss_value": "0.0",
"retained_iss_value": "0.0",
"service_provided_city": "Rio de Janeiro",
"service_provided_city_code": "3304557",
"service_provided_state": "RJ",
"cancellation_requested_at": null,
"cancelled_at": null,
"integration_errors": null,
"request_sent": null,
"organization_id": 1,
"customer_email": "customer@gmail.com",
"iss_value": "0.5",
"customer_name": "Customer Name",
"customer_company_name": "Cutomer Company Name",
"customer_document_number": "32403309000242",
"customer_city": "São Paulo",
"customer_city_ibge_code": null,
"customer_state": "",
"customer_city_inscription": null,
"customer_state_inscription": null,
"customer_address": "Rua 01",
"customer_number": "199",
"customer_complement": "CONJ 91",
"customer_district": "Vila 01",
"customer_zipcode": "74552000",
"organization_name": "Organization Name",
"organization_company_name": "Organization Name",
"organization_document_number": "23499377000123",
"organization_city": "Rio de Janeiro",
"organization_city_ibge_code": "IBGE CODE",
"organization_state": "RJ",
"organization_city_inscription": null,
"organization_state_inscription": null,
"organization_address": "Rua 01",
"organization_number": "01",
"organization_complement": null,
"organization_district": "Centro",
"organization_zipcode": "74394455",
"organization_is_incentivador_cultural": false,
"organization_is_optante_simples_nacional": false,
"rps_number": 1,
"rps_serie": "1",
"nfse_environment": "Producao",
"accrual_date": "05/08/2024",
"outras_value": "0.0",
"servico_prestado_municipio_prestador": true,
"servico_prestado_municipio_codigo": "",
"pdf_url": "https://faturamento.fintera.com.br/docs/MfyrCc2aQPxx81xaTDDhbgy3/nfse-01.pdf",
"xml_url": "https://faturamento.fintera.com.br/docs/XRrVjp6QC6kPsx3NPFtNMDN5/nfse-01.xml",
"nfse_service_items": [
{
"id": 1,
"description": "Cobrança pelo volume da utilização do serviço. Conforme lei 12.741/12, a carga tributária aproximada é de R$ 1,63 (16,33%), segundo a fonte IBPT",
"codigo_servico_municipal": "010601",
"item_lista_servico": "0106",
"external_service_id": "",
"cnae": null,
"value": "100.0",
"aliquota_iss": "5.0",
"units": "1.0",
"nfse_id": 1,
"created_at": "05/08/2024 11:37:37 -03:00",
"updated_at": "05/08/2024 11:37:37 -03:00",
"descricao_servico_municipal": ""
}
]
}
]
}
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": ""
}
]
}
Modelos de Cobrança
Detalhes de Modelo de Cobrança
Mostra detalhes de um Modelo de Cobrança
GET
api/v1/organizations/{organization_id}/charge_templates/{id}
Exemplo: api/v1/organizations/123/charge_templates/16
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"charge_template": {
"id": 16,
"name": "Teste 3",
"interest_value": "0.0",
"fine_value": "0.0",
"instructions": "",
"organization_id": 123,
"financial_account_id": 1,
"charging_account_id": null,
"payment_method": "boleto",
"fine_type": "without",
"interest_type": "without",
"created_at": "2021-03-01T20:48:07.614-03:00",
"updated_at": "2021-03-01T20:48:07.614-03:00"
}
}
Lista Modelos de Cobrança
Lista todos os modelos de cobrança de uma organização
GET
api/v1/organizations/{organization_id}/charge_templates
Exemplo: api/v1/organizations/123/charge_templates
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"charge_templates":
[
{
"id": 16,
"name": "Teste 3",
"interest_value": "0.0",
"fine_value": "0.0",
"instructions": "",
"organization_id": 123,
"financial_account_id": 1,
"payment_method": "boleto",
"fine_type": "without",
"interest_type": "without",
"created_at": "2021-03-01T20:48:07.614-03:00",
"updated_at": "2021-03-01T20:48:07.614-03:00"
},
{
"id": 18,
"name": "Teste 5",
"interest_value": "0.0",
"fine_value": "10.0",
"instructions": "",
"organization_id": 123,
"financial_account_id": null,
"charging_account_id": "52aaaaaa-51ee-41dd-af55-cd0000000000"
"payment_method": "boleto",
"fine_type": "fixed",
"interest_type": "percentage",
"created_at": "2021-03-01T20:48:22.921-03:00",
"updated_at": "2021-03-01T20:48:22.921-03:00"
}
]
}
Contas Digitais
Detalhes de Conta Digital
Mostra detalhes de uma Conta Digital
GET
api/v1/organizations/{organization_id}/financial_accounts/{id}
Exemplo: api/v1/organizations/123/financial_accounts/1
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"financial_account": {
"id": 1,
"status": "processing",
"bank_code": "341",
"bank_branch": "4644",
"bank_account": "095210",
"organization_id": 123,
"payout_bank_code": "001",
"payout_bank_branch": "4444",
"payout_bank_account": "111111",
"payment_methods": ["boleto"],
"accept_fixed_fine": false,
"created_at": "2021-02-17T12:06:36.250-03:00",
"updated_at": "2021-02-24T15:11:46.766-03:00"
}
}
Lista de Contas Digitais
Lista todos as contas de digitais de uma organização
GET
api/v1/organizations/{organization_id}/financial_accounts
Exemplo: api/v1/organizations/123/financial_accounts
Exemplo de Corpo
"Essa requisição não possui corpo"
Exemplo do retorno
{
"financial_accounts":
[
{
"id": 1,
"status": "processing",
"bank_code": "341",
"bank_branch": "4644",
"bank_account": "095210",
"organization_id": 123,
"payout_bank_code": "001",
"payout_bank_branch": "4444",
"payout_bank_account": "111111",
"payment_methods": [],
"accept_fixed_fine": false,
"created_at": "2021-02-17T12:06:36.250-03:00",
"updated_at": "2021-02-24T15:11:46.766-03:00",
}
]
}
Health Check
Retorna 200 OK e o valor fixo "OK", se o sistema estiver funcionando corretamente.
GET
health_check
Exemplo do retorno
{
"status": "ok"
}