Titulo a receber

Consulta Títulos a Receber

get

/financeiro/v1/titulo/receber

API para integração de Títulos a Receber. 1-Devido a limitação do Swagger na quantidade de caracters que podem ser retornadas, foram criados os campos abaixo para limitar a quantidade de registros quando necessário. O erro retornado quando o limite de caracteres é ultrapassado é "413 - request entity too large".

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

limitinteger · int32 · mín: 1 · máx: 100Opcional

Quantidade máxima de items retornados.

Default: 20

offsetinteger · int32Opcional

Quantidade de items para ignorar antes de retornar resultado.

Default: 0

qstringOpcional

O filtro é permitido apenas pelos atributos do objeto principal.

Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.

A filtragem é o processo de limitar um recurso de coleção usando uma definição de filtro dinâmico por solicitação em vários recursos de página, em que cada página contém um subconjunto de itens encontrados na coleção completa. A filtragem permite a passagem eficiente de grandes coleções.

Para filtrar em uma consulta, inclua o parâmetro q=FilterObject, onde FilterObject é um objeto JSON que representa a seleção e classificação customizadas a serem aplicadas ao recurso. Por exemplo, suponha o seguinte recurso:

https://api.systextil.com

A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":

https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}

Gramática FilterObject

FilterObject { orderby , asof, wmembers }

orderby
  "$orderby": {orderByMembers}
 
orderByMembers
    orderByProperty
    orderByProperty , orderByMembers
 
orderByProperty
    columnName : sortingValue
 
sortingValue
  "ASC"
  "DESC"
  "-1"
  "1"
   -1
   1
   
asof
  "$asof": date
  "$asof": "datechars"
  "$asof": scn
  "$asof": +int
 
wmembers
    wpair
    wpair , wmembers
 
wpair
    columnProperty
    complexOperatorProperty
 
columnProperty
    columnName : string
    columnName : number
    columnName : date
    columnName : simpleOperatorObject
columnName : complexOperatorObject
    columnName : [complexValues]
 
columnName
  "\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
 
complexOperatorProperty
    complexKey : [complexValues]
    complexKey : simpleOperatorObject 
 
complexKey
  "$and"
  "$or"
 
complexValues
    complexValue , complexValues
 
complexValue
    simpleOperatorObject
    complexOperatorObject
    columnObject
 
columnObject
    {columnProperty}
 
simpleOperatorObject
    {simpleOperatorProperty}
 
complexOperatorObject
    {complexOperatorProperty}
 
simpleOperatorProperty
   "$eq" : string | number | date
   "$ne" : string | number | date
   "$lt" :  number | date
   "$lte" : number | date
   "$gt" : number | date
   "$gte" : number | date
   "$instr" : string 
   "$ninstr" : string
   "$like" : string
   "$null" : null
   "$notnull" : null
   "$between" : betweenValue
 
betweenValue
    [null , betweenNotNull]
    [betweenNotNull , null]
    [betweenRegular , betweenRegular]
 
betweenNotNull
    number
    date
    
betweenRegular
    string
    number
    date

Definições de tipo de dados incluem o seguinte:

string 
       JSONString
number
       JSONNumber
date
       {"$date":"datechars"}
scn
       {"$scn": +int}

where

Datechars é um formato de data RFC3339 em UTC (Z)
        
 
JSONString
          ""
          " chars "
chars
         char
         char chars
char
         any-Unicode-character except-"-or-\-or-control-character
          \"
          \\
           \/
          \b
          \f
          \n
          \r
          \t
          \u four-hex-digits
 
 
JSONNumber
    int
    int frac
    int exp
    int frac exp
int
    digit
    digit1-9 digits 
    - digit
    - digit1-9 digits
frac
    . digits
exp
    e digits
digits
    digit
    digit digits
e
    e
    e+
    e-
    E
    E+
    E-

O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986

Exemplos

A seguir estão exemplos de operadores em especificações de FilterObject.

ORDER BY property ($orderby)

Order by with literals

{
"$orderby": {"SALARY":  "ASC","ENAME":"DESC"}
}

Order by with numbers

```json

{ "$orderby": {"SALARY": -1,"ENAME": 1} }

 
y ($asof)
 
### With SCN (Implicit)
```json 
{
  "$asof": 1273919
}

With SCN (Explicit)

{
  "$asof": {"$scn": "1273919"}
}

With Date (Implicit)

{
  "$asof": "2014-06-30T00:00:00Z"
}

With Date (Explicit)

{
  "$asof": {"$date": "2014-06-30T00:00:00Z"}
}

EQUALS operator ($eq)

(Implicit and explicit equality supported._

Implicit (Support String and Dates too)

{
 "SALARY": 1000
}

Explicit

{
 "SALARY": {"$eq": 1000}
}

Strings

{
 "ENAME": {"$eq":"SMITH"}
}

Dates

{
  "HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}

NOT EQUALS operator ($ne)

Number

{
 "SALARY": {"$ne": 1000}
}

String

```json

{ "ENAME": {"$ne":"SMITH"} }

 
#### Dates
  ```json
{
  "HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}

LESS THAN operator ($lt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}

LESS THAN OR EQUALS operator ($lte)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lte": 10000} }


#### Dates
  ```json
{
  "HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN operator ($gt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$gt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN OR EQUALS operator ($gte)

(Supports dates and numbers only)

Numbers

{
  "SALARY": {"$gte": 10000}
}

Dates

{
  "HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}

In string operator ($instr)

(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }

 
#### Not in string operator ($ninstr)
(Supports strings only)
  ```json
{
  "ENAME": {"$ninstr":"MC"}
}

####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }

 
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
 
#### Numbers
```json
{
  "SALARY": {"$between": [1000,2000]}
}

Dates

```json

{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }

 
#### Strings
```json
{
  "ENAME": {"$between": ["A","C"]}
}

Null Ranges ($lte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [null,2000]}
}

Null Ranges ($gte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [1000,null]}
}

NULL operator ($null)

{
  "ENAME": {"$null": null}
}

NOT NULL operator ($notnull)

{
  "ENAME": {"$notnull": null}
}

AND operator ($and)

(Supports all operators, including $and and $or)

Column context delegation

(Operators inside $and will use the closest context defined in the JSON tree.)

{
 "SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}

Column context override

(Example: salary greater than 1000 and name like S%)

{
  "SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Implicit and in columns

{
  "SALARY": [{"$gt": 1000},{"$lt":4000}] 
}

High order AND

(All first columns and or high order operators -- $and and $ors -- defined at the first level of the JSON will be joined and an implicit AND) (Example: Salary greater than 1000 and name starts with S or T)

{
  "SALARY": {"$gt": 1000}, 
  "ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]} 
}

Invalid expression (operators $lt and $gt lack column context)

{
   "$and": [{"$lt": 5000},{"$gt": 1000}]
}

Valid alternatives for the previous invalid expression

{
   "$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}

{
   "SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
 
{
   "SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}

OR operator ($or)

(Supports all operators including $and and $or)

Column context delegation

(Operators inside $or will use the closest context defined in the JSON tree)

{
  "ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}

Column context override

(Example: name starts with S or salary greater than 1000)

{
  "SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Respostas

200

Sucesso.

application/json

empresa_idnumber · máx: 3Obrigatório

Código da empresa

Example: 3

empresa_descricaostring · máx: 35Opcional

Nome da empresa

Example: CLIENTE TEXTIL

cnpj9_clientenumber · máx: 9Obrigatório

Os 9 dígitos principais do CNPJ ou CPF

Example: 4273385

cnpj4_clientenumber · máx: 4Obrigatório

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 1

cnpj2_clientenumber · máx: 2Obrigatório

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 64

nome_clientestring · máx: 40Opcional

Nome do cliente

Example: CONFECCOES ALTA MODA LTDA

duplicatanumber · máx: 9Obrigatório

Numero da duplicata

Example: 267604

duplicata_parcelanumber · máx: 2Obrigatório

Sequência da duplicata

Example: 1

tipo_titulo_idnumber · máx: 2Opcional

Tipo de título

Example: 1

tipo_titulo_descricaostring · máx: 20Opcional

Descrição do tipo de título

Example: TITULO FATURAMENTO

situacao_duplicatanumber · máx: 1Opcional

Situação da duplicata: (0) - em aberto, (1) - pago total, (2) - cancelado, (3) - pago a menor, (4) - pago a maior.

Example: 1

portador_duplicata_idnumber · máx: 3Opcional

Código do portador da duplicata

Example: 246

portador_duplicata_descricaostring · máx: 15Opcional

Nome do portador

Example: BANCO ABC

data_emissaostring · date-timeOpcional

Data de emissão

Example: 2022-03-16T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

data_vencimento_duplicatastring · date-timeOpcional

Data de vencimento da duplicata

Example: 2022-07-14T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

data_prorrogacaostring · date-timeOpcional

Data de prorrogação da duplicata

Example: 2022-07-14T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

valor_duplicatanumber · máx: 15Opcional

Valor da duplicata

Example: 161884.8

saldo_duplicatanumber · máx: 15Opcional

Saldo da duplicata

Example: 0

moeda_idnumber · máx: 2Opcional

Código da Moeda

Example: 0

moeda_descricaostring · máx: 20Opcional

Descrição da moeda

Example: REAL

valor_moedanumber · máx: 15Opcional

Valor na moeda do titulo'

Example: 161884.8

cnpj9_responsavelnumber · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF

Example: 0

cnpj4_responsavelnumber · máx: 4Opcional

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 0

cnpj2_responsavelnumber · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 0

nome_responsavelstring · máx: 40Opcional

Nome do responsável pelo titulo

cnpj9_endossonumber · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF

Example: 0

cnpj4_endossonumber · máx: 4Opcional

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 0

cnpj2_endossonumber · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 0

nome_endossostring · máx: 40Opcional

Nome do endosso

pedido_vendanumber · máx: 6Opcional

Código do pedido de venda

Example: 357491

codigo_representantenumber · máx: 5Opcional

Código do representante

Example: 254

nome_representantestring · máx: 40Opcional

Nome do representante

Example: DONNA BELLA REPRESENTACOES EIRELI

percentual_comissaonumber · máx: 6Opcional

Percentual da comissão

Example: 1.75

base_calculo_comissaonumber · máx: 15Opcional

Base de calculo da comissão

Example: 161884.8

valor_comissaonumber · máx: 15Opcional

Valor da comissão

Example: 2832.98

numero_borderonumber · máx: 5Opcional

Número do borderô

Example: 0

numero_remessanumber · máx: 7Opcional

Número da remessa

Example: 20

numero_titulo_bancostring · máx: 20Opcional

Número do titulo no banco

Example: 30842742

conta_corrente_remessanumber · máx: 9Opcional

Número da conta corrente da remessa

Example: 6607522

codigo_carteiranumber · máx: 3Opcional

Código da carteira

Example: 3

transacao_idnumber · máx: 3Opcional

Código da transação

Example: 1

transacao_descricaostring · máx: 20Opcional

Descrição da transação

Example: VENDAS MERC INTERNO

percentual_desconto_duplicatanumber · máx: 6Opcional

Percentual de desconto da duplicata

Example: 0

numero_solicitacaonumber · máx: 6Opcional

Número da solicitação de bordero a ser impressa

Example: 0

posicao_duplicata_idnumber · máx: 2Opcional

Código da posição da duplicata

Example: 1

posicao_duplicata_descricaostring · máx: 15Opcional

Descrição da posição da duplicata

Example: COBRANCA

previsaonumber · máx: 1Opcional

(0) - Titulo confirmado ou (1) - Previsão

Example: 0

codigo_localnumber · máx: 3Opcional

Código da empresa local do titulo

Example: 3

duplicata_emitidanumber · máx: 1Opcional

"(0) - Titulo liberado;(1) - Titulo selecionado para cobranca;(3) - Titulo em cobranca no banco;(4) - Titulo liquidado;(5) - Titulo aguardando confirmacao de arquivo para cobranca;(7) - Bordero ou(8) - Gerado pelo Obrigacoes Fiscais."

Example: 4

codigo_historico_contabilnumber · máx: 4Opcional

Código do histórico contábil

Example: 1

complemento_historico_contabilstring · máx: 60Opcional

Complemento para o histórico contábil

duplicata_impressanumber · máx: 1Opcional

Informação da empressão da duplicata (0) - título não impresso ou (1) - título impresso

Example: 0

numero_lancamento_contabilnumber · máx: 9Opcional

Número do lançamento contábil

Example: 2438

numero_cupomnumber · máx: 9Opcional

Número do cupom quando a origem for da loja

Example: 0

forma_pagamento_loja_idnumber · máx: 2Opcional

Código da forma de pagamento quando a origem for da loja

Example: 0

forma_pagamento_loja_descricaostring · máx: 30Opcional

Descrição da forma de pagamento quando a origem for da loja

Example: BOLETO

numero_remessa_scpcnumber · máx: 9Opcional

Número da remessa para SCPC

Example: 0

situacao_scpcnumber · máx: 1Opcional

Situação remessa SCPC (0)-Não enviado, (1)- Selecionado, (5) - Incluído e (4) -Liquidado

Example: 0

codigo_barrasstring · máx: 80Opcional

Código de barras da duplicata a receber

linha_digitavel_codigostring · máx: 80Opcional

Linha digitavel do código de barras da duplicata a receber

renegociadostring · máx: 5Opcional

Indica se o título foi baixado por renegociação ("true" / "false")

Example: false

data_atualizacao_apistring · date-timeOpcional

Data de atualização da API.

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

401

Não autorizado.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

get

/financeiro/v1/titulo/receber

GET /financeiro/v1/titulo/receber HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "empresa_id": 3,
  "empresa_descricao": "CLIENTE TEXTIL",
  "cnpj9_cliente": 4273385,
  "cnpj4_cliente": 1,
  "cnpj2_cliente": 64,
  "nome_cliente": "CONFECCOES ALTA MODA LTDA",
  "duplicata": 267604,
  "duplicata_parcela": 1,
  "tipo_titulo_id": 1,
  "tipo_titulo_descricao": "TITULO FATURAMENTO",
  "situacao_duplicata": 1,
  "portador_duplicata_id": 246,
  "portador_duplicata_descricao": "BANCO ABC",
  "data_emissao": "2022-03-16T03:00:00Z",
  "data_vencimento_duplicata": "2022-07-14T03:00:00Z",
  "data_prorrogacao": "2022-07-14T03:00:00Z",
  "valor_duplicata": 161884.8,
  "saldo_duplicata": 0,
  "moeda_id": 0,
  "moeda_descricao": "REAL",
  "valor_moeda": 161884.8,
  "cnpj9_responsavel": 0,
  "cnpj4_responsavel": 0,
  "cnpj2_responsavel": 0,
  "nome_responsavel": null,
  "cnpj9_endosso": 0,
  "cnpj4_endosso": 0,
  "cnpj2_endosso": 0,
  "nome_endosso": null,
  "pedido_venda": 357491,
  "codigo_representante": 254,
  "nome_representante": "DONNA BELLA REPRESENTACOES EIRELI",
  "percentual_comissao": 1.75,
  "base_calculo_comissao": 161884.8,
  "valor_comissao": 2832.98,
  "numero_bordero": 0,
  "numero_remessa": 20,
  "numero_titulo_banco": "30842742",
  "conta_corrente_remessa": 6607522,
  "codigo_carteira": 3,
  "transacao_id": 1,
  "transacao_descricao": "VENDAS MERC INTERNO",
  "percentual_desconto_duplicata": 0,
  "numero_solicitacao": 0,
  "posicao_duplicata_id": 1,
  "posicao_duplicata_descricao": "COBRANCA",
  "previsao": 0,
  "codigo_local": 3,
  "duplicata_emitida": 4,
  "codigo_historico_contabil": 1,
  "complemento_historico_contabil": null,
  "duplicata_impressa": 0,
  "numero_lancamento_contabil": 2438,
  "numero_cupom": 0,
  "forma_pagamento_loja_id": 0,
  "forma_pagamento_loja_descricao": "BOLETO",
  "numero_remessa_scpc": 0,
  "situacao_scpc": 0,
  "codigo_barras": null,
  "linha_digitavel_codigo": null,
  "renegociado": "false",
  "data_atualizacao_api": null,
  "informacoes_gerais": [],
  "recebimentos": [],
  "cheques_terceiro": []
}

Cadastro Títulos a Receber

post

/financeiro/v1/titulo/receber

API para integração de POST de Titulos a receber.

(*) - Campos obrigatórios/campos chave: empresa_id, cnpj9_cliente, cnpj4_cliente, cnpj2_cliente, duplicata, duplicata_parcela

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

201

Sucesso na inclusão.

application/json

400

Erro em validação de negócio.

application/json

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

409

Requisição não aceita, envio já cadastrado.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

post

/financeiro/v1/titulo/receber

POST /financeiro/v1/titulo/receber HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1742

{
  "items": [
    {
      "empresa_id": 3,
      "empresa_descricao": "CLIENTE TEXTIL",
      "cnpj9_cliente": 4273385,
      "cnpj4_cliente": 1,
      "cnpj2_cliente": 64,
      "nome_cliente": "CONFECCOES ALTA MODA LTDA",
      "duplicata": 267604,
      "duplicata_parcela": 1,
      "tipo_titulo_id": 1,
      "tipo_titulo_descricao": "TITULO FATURAMENTO",
      "situacao_duplicata": 1,
      "portador_duplicata_id": 246,
      "portador_duplicata_descricao": "BANCO ABC",
      "data_emissao": "2022-03-16T03:00:00Z",
      "data_vencimento_duplicata": "2022-07-14T03:00:00Z",
      "data_prorrogacao": "2022-07-14T03:00:00Z",
      "valor_duplicata": 161884.8,
      "saldo_duplicata": 0,
      "moeda_id": 0,
      "moeda_descricao": "REAL",
      "valor_moeda": 161884.8,
      "cnpj9_responsavel": 0,
      "cnpj4_responsavel": 0,
      "cnpj2_responsavel": 0,
      "nome_responsavel": null,
      "cnpj9_endosso": 0,
      "cnpj4_endosso": 0,
      "cnpj2_endosso": 0,
      "nome_endosso": null,
      "pedido_venda": 357491,
      "codigo_representante": 254,
      "nome_representante": "DONNA BELLA REPRESENTACOES EIRELI",
      "percentual_comissao": 1.75,
      "base_calculo_comissao": 161884.8,
      "valor_comissao": 2832.98,
      "numero_bordero": 0,
      "numero_remessa": 20,
      "numero_titulo_banco": "30842742",
      "conta_corrente_remessa": 6607522,
      "codigo_carteira": 3,
      "transacao_id": 1,
      "transacao_descricao": "VENDAS MERC INTERNO",
      "percentual_desconto_duplicata": 0,
      "numero_solicitacao": 0,
      "posicao_duplicata_id": 1,
      "posicao_duplicata_descricao": "COBRANCA",
      "previsao": 0,
      "codigo_local": 3,
      "duplicata_emitida": 4,
      "codigo_historico_contabil": 1,
      "complemento_historico_contabil": null,
      "duplicata_impressa": 0,
      "numero_lancamento_contabil": 2438,
      "numero_cupom": 0,
      "forma_pagamento_loja_id": 0,
      "forma_pagamento_loja_descricao": "BOLETO",
      "numero_remessa_scpc": 0,
      "situacao_scpc": 0,
      "codigo_barras": null,
      "linha_digitavel_codigo": null,
      "renegociado": "false",
      "data_atualizacao_api": null,
      "informacoes_gerais": [],
      "recebimentos": [],
      "cheques_terceiro": []
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Alteração Títulos a Receber

put

/financeiro/v1/titulo/receber

API para integração de PUT de Titulos a receber.

(*) - Campos obrigatórios/campos chave: empresa_id, cnpj9_cliente, cnpj4_cliente, cnpj2_cliente, duplicata, duplicata_parcela

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

200

Sucesso.

application/json

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

put

/financeiro/v1/titulo/receber

PUT /financeiro/v1/titulo/receber HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1742

{
  "items": [
    {
      "empresa_id": 3,
      "empresa_descricao": "CLIENTE TEXTIL",
      "cnpj9_cliente": 4273385,
      "cnpj4_cliente": 1,
      "cnpj2_cliente": 64,
      "nome_cliente": "CONFECCOES ALTA MODA LTDA",
      "duplicata": 267604,
      "duplicata_parcela": 1,
      "tipo_titulo_id": 1,
      "tipo_titulo_descricao": "TITULO FATURAMENTO",
      "situacao_duplicata": 1,
      "portador_duplicata_id": 246,
      "portador_duplicata_descricao": "BANCO ABC",
      "data_emissao": "2022-03-16T03:00:00Z",
      "data_vencimento_duplicata": "2022-07-14T03:00:00Z",
      "data_prorrogacao": "2022-07-14T03:00:00Z",
      "valor_duplicata": 161884.8,
      "saldo_duplicata": 0,
      "moeda_id": 0,
      "moeda_descricao": "REAL",
      "valor_moeda": 161884.8,
      "cnpj9_responsavel": 0,
      "cnpj4_responsavel": 0,
      "cnpj2_responsavel": 0,
      "nome_responsavel": null,
      "cnpj9_endosso": 0,
      "cnpj4_endosso": 0,
      "cnpj2_endosso": 0,
      "nome_endosso": null,
      "pedido_venda": 357491,
      "codigo_representante": 254,
      "nome_representante": "DONNA BELLA REPRESENTACOES EIRELI",
      "percentual_comissao": 1.75,
      "base_calculo_comissao": 161884.8,
      "valor_comissao": 2832.98,
      "numero_bordero": 0,
      "numero_remessa": 20,
      "numero_titulo_banco": "30842742",
      "conta_corrente_remessa": 6607522,
      "codigo_carteira": 3,
      "transacao_id": 1,
      "transacao_descricao": "VENDAS MERC INTERNO",
      "percentual_desconto_duplicata": 0,
      "numero_solicitacao": 0,
      "posicao_duplicata_id": 1,
      "posicao_duplicata_descricao": "COBRANCA",
      "previsao": 0,
      "codigo_local": 3,
      "duplicata_emitida": 4,
      "codigo_historico_contabil": 1,
      "complemento_historico_contabil": null,
      "duplicata_impressa": 0,
      "numero_lancamento_contabil": 2438,
      "numero_cupom": 0,
      "forma_pagamento_loja_id": 0,
      "forma_pagamento_loja_descricao": "BOLETO",
      "numero_remessa_scpc": 0,
      "situacao_scpc": 0,
      "codigo_barras": null,
      "linha_digitavel_codigo": null,
      "renegociado": "false",
      "data_atualizacao_api": null,
      "informacoes_gerais": [],
      "recebimentos": [],
      "cheques_terceiro": []
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Exclusão Títulos a Receber

delete

/financeiro/v1/titulo/receber

API para integração de exclusão de Titulos a receber.

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

qstringOpcional

O filtro é permitido apenas pelos atributos do objeto principal.

Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.

https://api.systextil.com

A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":

https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}

Gramática FilterObject

FilterObject { orderby , asof, wmembers }

orderby
  "$orderby": {orderByMembers}
 
orderByMembers
    orderByProperty
    orderByProperty , orderByMembers
 
orderByProperty
    columnName : sortingValue
 
sortingValue
  "ASC"
  "DESC"
  "-1"
  "1"
   -1
   1
   
asof
  "$asof": date
  "$asof": "datechars"
  "$asof": scn
  "$asof": +int
 
wmembers
    wpair
    wpair , wmembers
 
wpair
    columnProperty
    complexOperatorProperty
 
columnProperty
    columnName : string
    columnName : number
    columnName : date
    columnName : simpleOperatorObject
columnName : complexOperatorObject
    columnName : [complexValues]
 
columnName
  "\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
 
complexOperatorProperty
    complexKey : [complexValues]
    complexKey : simpleOperatorObject 
 
complexKey
  "$and"
  "$or"
 
complexValues
    complexValue , complexValues
 
complexValue
    simpleOperatorObject
    complexOperatorObject
    columnObject
 
columnObject
    {columnProperty}
 
simpleOperatorObject
    {simpleOperatorProperty}
 
complexOperatorObject
    {complexOperatorProperty}
 
simpleOperatorProperty
   "$eq" : string | number | date
   "$ne" : string | number | date
   "$lt" :  number | date
   "$lte" : number | date
   "$gt" : number | date
   "$gte" : number | date
   "$instr" : string 
   "$ninstr" : string
   "$like" : string
   "$null" : null
   "$notnull" : null
   "$between" : betweenValue
 
betweenValue
    [null , betweenNotNull]
    [betweenNotNull , null]
    [betweenRegular , betweenRegular]
 
betweenNotNull
    number
    date
    
betweenRegular
    string
    number
    date

Definições de tipo de dados incluem o seguinte:

string 
       JSONString
number
       JSONNumber
date
       {"$date":"datechars"}
scn
       {"$scn": +int}

where

Datechars é um formato de data RFC3339 em UTC (Z)
        
 
JSONString
          ""
          " chars "
chars
         char
         char chars
char
         any-Unicode-character except-"-or-\-or-control-character
          \"
          \\
           \/
          \b
          \f
          \n
          \r
          \t
          \u four-hex-digits
 
 
JSONNumber
    int
    int frac
    int exp
    int frac exp
int
    digit
    digit1-9 digits 
    - digit
    - digit1-9 digits
frac
    . digits
exp
    e digits
digits
    digit
    digit digits
e
    e
    e+
    e-
    E
    E+
    E-

O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986

Exemplos

A seguir estão exemplos de operadores em especificações de FilterObject.

ORDER BY property ($orderby)

Order by with literals

{
"$orderby": {"SALARY":  "ASC","ENAME":"DESC"}
}

Order by with numbers

```json

{ "$orderby": {"SALARY": -1,"ENAME": 1} }

 
y ($asof)
 
### With SCN (Implicit)
```json 
{
  "$asof": 1273919
}

With SCN (Explicit)

{
  "$asof": {"$scn": "1273919"}
}

With Date (Implicit)

{
  "$asof": "2014-06-30T00:00:00Z"
}

With Date (Explicit)

{
  "$asof": {"$date": "2014-06-30T00:00:00Z"}
}

EQUALS operator ($eq)

(Implicit and explicit equality supported._

Implicit (Support String and Dates too)

{
 "SALARY": 1000
}

Explicit

{
 "SALARY": {"$eq": 1000}
}

Strings

{
 "ENAME": {"$eq":"SMITH"}
}

Dates

{
  "HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}

NOT EQUALS operator ($ne)

Number

{
 "SALARY": {"$ne": 1000}
}

String

```json

{ "ENAME": {"$ne":"SMITH"} }

 
#### Dates
  ```json
{
  "HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}

LESS THAN operator ($lt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}

LESS THAN OR EQUALS operator ($lte)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lte": 10000} }


#### Dates
  ```json
{
  "HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN operator ($gt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$gt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN OR EQUALS operator ($gte)

(Supports dates and numbers only)

Numbers

{
  "SALARY": {"$gte": 10000}
}

Dates

{
  "HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}

In string operator ($instr)

(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }

 
#### Not in string operator ($ninstr)
(Supports strings only)
  ```json
{
  "ENAME": {"$ninstr":"MC"}
}

####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }

 
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
 
#### Numbers
```json
{
  "SALARY": {"$between": [1000,2000]}
}

Dates

```json

{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }

 
#### Strings
```json
{
  "ENAME": {"$between": ["A","C"]}
}

Null Ranges ($lte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [null,2000]}
}

Null Ranges ($gte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [1000,null]}
}

NULL operator ($null)

{
  "ENAME": {"$null": null}
}

NOT NULL operator ($notnull)

{
  "ENAME": {"$notnull": null}
}

AND operator ($and)

(Supports all operators, including $and and $or)

Column context delegation

(Operators inside $and will use the closest context defined in the JSON tree.)

{
 "SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}

Column context override

(Example: salary greater than 1000 and name like S%)

{
  "SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Implicit and in columns

{
  "SALARY": [{"$gt": 1000},{"$lt":4000}] 
}

High order AND

{
  "SALARY": {"$gt": 1000}, 
  "ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]} 
}

Invalid expression (operators $lt and $gt lack column context)

{
   "$and": [{"$lt": 5000},{"$gt": 1000}]
}

Valid alternatives for the previous invalid expression

{
   "$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}

{
   "SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
 
{
   "SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}

OR operator ($or)

(Supports all operators including $and and $or)

Column context delegation

(Operators inside $or will use the closest context defined in the JSON tree)

{
  "ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}

Column context override

(Example: name starts with S or salary greater than 1000)

{
  "SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Respostas

200

Sucesso.

application/json

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

delete

/financeiro/v1/titulo/receber

DELETE /financeiro/v1/titulo/receber HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

AnteriorTitulo a Pagar PróximoRecebimento

Atualizado há 25 dias

Isto foi útil?

hashtagConsulta Títulos a Receber

Gramática FilterObject

Exemplos

ORDER BY property ($orderby)

Order by with numbers

With SCN (Explicit)

With Date (Implicit)

With Date (Explicit)

EQUALS operator ($eq)

Strings

Dates

NOT EQUALS operator ($ne)

Number

String

LESS THAN operator ($lt)

Numbers

LESS THAN OR EQUALS operator ($lte)

Numbers

GREATER THAN operator ($gt)

Numbers

GREATER THAN OR EQUALS operator ($gte)

Numbers

Dates

In string operator ($instr)

Dates

Null Ranges ($lte equivalent)

Null Ranges ($gte equivalent)

NULL operator ($null)

NOT NULL operator ($notnull)

AND operator ($and)

Column context delegation

Column context override

High order AND

Invalid expression (operators $lt and $gt lack column context)

Valid alternatives for the previous invalid expression

OR operator ($or)

Column context delegation

Column context override

hashtagCadastro Títulos a Receber

hashtagAPI para integração de POST de Titulos a receber.

hashtagAlteração Títulos a Receber

hashtagAPI para integração de PUT de Titulos a receber.

hashtagExclusão Títulos a Receber

hashtagAPI para integração de exclusão de Titulos a receber.

Gramática FilterObject

Exemplos

ORDER BY property ($orderby)

Order by with numbers

With SCN (Explicit)

With Date (Implicit)

With Date (Explicit)

EQUALS operator ($eq)

Strings

Dates

NOT EQUALS operator ($ne)

Number

String

LESS THAN operator ($lt)

Numbers

LESS THAN OR EQUALS operator ($lte)

Numbers

GREATER THAN operator ($gt)

Numbers

GREATER THAN OR EQUALS operator ($gte)

Numbers

Dates

In string operator ($instr)

Dates

Null Ranges ($lte equivalent)

Null Ranges ($gte equivalent)

NULL operator ($null)

NOT NULL operator ($notnull)

AND operator ($and)

Column context delegation

Column context override

High order AND

Invalid expression (operators $lt and $gt lack column context)

Valid alternatives for the previous invalid expression

OR operator ($or)

Column context delegation

Consulta Títulos a Receber

Cadastro Títulos a Receber

API para integração de POST de Titulos a receber.

Alteração Títulos a Receber

API para integração de PUT de Titulos a receber.

Exclusão Títulos a Receber

API para integração de exclusão de Titulos a receber.