Uptime serviços Zydon

Financials

Obter Financeiro

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
get
GET /api/sales/financials/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "partner_id": "text",
  "partner_name": "text",
  "order_id": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-07-14T10:02:44.394Z",
  "due_date": "2025-07-14T10:02:44.394Z",
  "status": "text",
  "has_online_payment": true,
  "type": "CREDIT_CARD",
  "card": {
    "financial_id": "text",
    "brand": "text",
    "number": "text",
    "expiration_month": "text",
    "expiration_year": "text",
    "nsu": "text",
    "tid": "text",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-07-14T10:02:44.394Z",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": "2025-07-14T10:02:44.394Z"
  },
  "pix": {
    "qr_code": "text",
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "payment_billet": {
    "financial_id": "text",
    "bar_code": "text",
    "qr_code": "text",
    "resource_file_id": "text",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-07-14T10:02:44.394Z",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": "2025-07-14T10:02:44.394Z"
  },
  "attachments": [
    {
      "id": "text",
      "is_payment_billet": true,
      "payment_billet_bar_code": "text",
      "payment_billet_qr_code": "text",
      "resource_files": [
        {
          "id": "text",
          "fileName": "text"
        }
      ]
    }
  ]
}

Atualizar Financeiro

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
partner_idstringObrigatório
valuenumberObrigatório
paying_off_valuenumberObrigatório
paying_off_datestring · date-timeObrigatório
reversed_valuenumberObrigatório
reversed_datestring · date-timeObrigatório
due_datestring · date-timeObrigatório
statusstringObrigatório
attachmentsstring · uuid[]Opcional
order_idstringOpcional
typestringOpcional
Respostas
200
Financial updated successfully
application/json
put
PUT /api/sales/financials/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 412

{
  "partner_id": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-07-14T10:02:44.394Z",
  "reversed_value": 1,
  "reversed_date": "2025-07-14T10:02:44.394Z",
  "due_date": "2025-07-14T10:02:44.394Z",
  "status": "text",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "bar_code": "text",
    "qr_code": "text"
  },
  "attachments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "order_id": "text",
  "type": "text"
}
{
  "id": "text",
  "partner_id": "text",
  "partner_name": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-07-14T10:02:44.394Z",
  "due_date": "2025-07-14T10:02:44.394Z",
  "status": "text",
  "order_id": "text",
  "type": "CREDIT_CARD",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "bar_code": "text",
    "qr_code": "text"
  },
  "attachments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Remover Financeiro

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
Financial removed successfully
application/json
delete
DELETE /api/sales/financials/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "id": "text"
}

Listar Financeiros

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
Respostas
200
OK
application/json
get
GET /api/sales/financials HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "value": 1,
      "paying_off_value": 1,
      "paying_off_date": "2025-07-14T10:02:44.394Z",
      "due_date": "2025-07-14T10:02:44.394Z",
      "status": "text",
      "order_id": "text",
      "type": "CREDIT_CARD"
    }
  ]
}

Criar Financeiro

post
Autorizações
Corpo
idstringOpcional
partner_idstringObrigatório
valuenumberObrigatório
paying_off_valuenumberObrigatório
paying_off_datestring · date-timeObrigatório
reversed_valuenumberObrigatório
reversed_datestring · date-timeObrigatório
due_datestring · date-timeObrigatório
statusstringObrigatório
attachmentsstring · uuid[]Opcional
order_idstringOpcional
typestringOpcional
Respostas
201
Financial created successfully
application/json
post
POST /api/sales/financials HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "id": "text",
  "partner_id": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-07-14T10:02:44.394Z",
  "reversed_value": 1,
  "reversed_date": "2025-07-14T10:02:44.394Z",
  "due_date": "2025-07-14T10:02:44.394Z",
  "status": "text",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "bar_code": "text",
    "qr_code": "text"
  },
  "attachments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "order_id": "text",
  "type": "text"
}
{
  "id": "text",
  "partner_id": "text",
  "partner_name": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-07-14T10:02:44.394Z",
  "due_date": "2025-07-14T10:02:44.394Z",
  "status": "text",
  "order_id": "text",
  "type": "CREDIT_CARD",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "bar_code": "text",
    "qr_code": "text"
  },
  "attachments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}