Financials

Obter Financeiro

GEThttps://api.zydon.com.br/api/sales/financials/{id}

Authorization

auth

Path parameters

id*string

Response

200404500

OK

Body

application/json

idstring

partner_idstring

partner_namestring

order_idstring

valuenumber

paying_off_valuenumber

paying_off_datestring (date-time)

due_datestring (date-time)

statusstring

payment_billetFinancialPaymentBilletResponse (object)

attachmentsarray of FinancialAttachmentResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/financials/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "partner_id": "text",
  "partner_name": "text",
  "order_id": "text",
  "value": 0,
  "paying_off_value": 0,
  "paying_off_date": "2024-12-21T14:32:12.563Z",
  "due_date": "2024-12-21T14:32:12.563Z",
  "status": "text",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "resource_file_name": "text",
    "bar_code": "text"
  },
  "attachments": [
    {
      "id": "text",
      "is_payment_billet": false,
      "payment_billet_bar_code": "text",
      "resource_files": [
        {
          "id": "text",
          "fileName": "text"
        }
      ]
    }
  ]
}

Atualizar Financeiro

PUThttps://api.zydon.com.br/api/sales/financials/{id}

Authorization

auth

Path parameters

id*string

Body

application/json

partner_id*string

value*number

paying_off_value*number

paying_off_date*string (date-time)

due_date*string (date-time)

status*string

payment_billetUpdateFinancialPaymentBilletRequest (object)

attachmentsarray of string (uuid)

order_idstring

Response

200422500

Financial updated successfully

Body

application/json

idstring

partner_idstring

partner_namestring

valuenumber

paying_off_valuenumber

paying_off_datestring (date-time)

due_datestring (date-time)

statusstring

order_idstring

payment_billetUpdateFinancialPaymentBilletResponse (object)

attachmentsarray of string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/financials/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "due_date": "2024-12-21T14:32:12.563Z",
      "partner_id": "text",
      "paying_off_date": "2024-12-21T14:32:12.563Z",
      "paying_off_value": 0,
      "status": "text",
      "value": 0
    }),
});
const data = await response.json();

Response

200422500

{
  "id": "text",
  "partner_id": "text",
  "partner_name": "text",
  "value": 0,
  "paying_off_value": 0,
  "paying_off_date": "2024-12-21T14:32:12.563Z",
  "due_date": "2024-12-21T14:32:12.563Z",
  "status": "text",
  "order_id": "text",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "bar_code": "text"
  },
  "attachments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Remover Financeiro

DELETEhttps://api.zydon.com.br/api/sales/financials/{id}

Authorization

auth

Path parameters

id*string

Response

204422500

Financial removed successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/financials/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

204

{
  "id": "text"
}

Listar Financeiros

GEThttps://api.zydon.com.br/api/sales/financials

Authorization

auth

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListFinancialResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/financials', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "value": 0,
      "paying_off_value": 0,
      "paying_off_date": "2024-12-21T14:32:12.563Z",
      "due_date": "2024-12-21T14:32:12.563Z",
      "status": "text",
      "order_id": "text"
    }
  ]
}

Criar Financeiro

POSThttps://api.zydon.com.br/api/sales/financials

Authorization

auth

Body

application/json

idstring

partner_id*string

value*number

paying_off_value*number

paying_off_date*string (date-time)

due_date*string (date-time)

status*string

payment_billetCreateFinancialPaymentBilletRequest (object)

attachmentsarray of string (uuid)

order_idstring

Response

201422500

Financial created successfully

Body

application/json

idstring

partner_idstring

partner_namestring

valuenumber

paying_off_valuenumber

paying_off_datestring (date-time)

due_datestring (date-time)

statusstring

order_idstring

payment_billetCreateFinancialPaymentBilletResponse (object)

attachmentsarray of string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/financials', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "due_date": "2024-12-21T14:32:12.563Z",
      "partner_id": "text",
      "paying_off_date": "2024-12-21T14:32:12.563Z",
      "paying_off_value": 0,
      "status": "text",
      "value": 0
    }),
});
const data = await response.json();

Response

201422500

{
  "id": "text",
  "partner_id": "text",
  "partner_name": "text",
  "value": 0,
  "paying_off_value": 0,
  "paying_off_date": "2024-12-21T14:32:12.563Z",
  "due_date": "2024-12-21T14:32:12.563Z",
  "status": "text",
  "order_id": "text",
  "payment_billet": {
    "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
    "bar_code": "text"
  },
  "attachments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}