Financials

Obter Financeiro

get

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

404

Financial was not found

application/json

500

An internal server error was thrown

application/json

get

/financials/{id}

HTTPcURLJavaScriptPython

GET /api/sales/financials/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "partner_id": "text",
  "partner_name": "text",
  "order_id": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-12-17T09:46:09.693Z",
  "due_date": "2025-12-17T09:46:09.693Z",
  "status": "text",
  "type": "text",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "resource_file_name": "text",
    "bar_code": "text",
    "qr_code": "text"
  },
  "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

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

partner_idstringObrigatório

valuenumberObrigatório

paying_off_valuenumberObrigatório

paying_off_datestring · date-timeObrigatório

due_datestring · date-timeObrigatório

statusstringObrigatório

attachmentsstring · uuid[]Opcional

order_idstringOpcional

typestringOpcional

Respostas

200

Financial updated successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

/financials/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/financials/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "partner_id": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-12-17T09:46:09.693Z",
  "due_date": "2025-12-17T09:46:09.693Z",
  "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-12-17T09:46:09.693Z",
  "due_date": "2025-12-17T09:46:09.693Z",
  "status": "text",
  "order_id": "text",
  "type": "text",
  "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

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

Financial removed successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete

/financials/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/financials/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text"
}

Listar Financeiros

get

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

404

Financial was not found

application/json

500

An internal server error was thrown

application/json

get

/financials

HTTPcURLJavaScriptPython

GET /api/sales/financials HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-17T09:46:09.693Z",
      "due_date": "2025-12-17T09:46:09.693Z",
      "status": "text",
      "order_id": "text",
      "type": "text"
    }
  ]
}

Criar Financeiro

post

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

partner_idstringObrigatório

valuenumberObrigatório

paying_off_valuenumberObrigatório

paying_off_datestring · date-timeObrigatório

due_datestring · date-timeObrigatório

statusstringObrigatório

attachmentsstring · uuid[]Opcional

order_idstringOpcional

typestringOpcional

Respostas

201

Financial created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/financials

HTTPcURLJavaScriptPython

POST /api/sales/financials HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "id": "text",
  "partner_id": "text",
  "value": 1,
  "paying_off_value": 1,
  "paying_off_date": "2025-12-17T09:46:09.693Z",
  "due_date": "2025-12-17T09:46:09.693Z",
  "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-12-17T09:46:09.693Z",
  "due_date": "2025-12-17T09:46:09.693Z",
  "status": "text",
  "order_id": "text",
  "type": "text",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "bar_code": "text",
    "qr_code": "text"
  },
  "attachments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}