Status

Retrieve an existing status given an ID

get

Authorizations

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

idstring · uuidrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/status/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "relations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "destiny": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "title": "text"
      },
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-03-25T21:19:59.431Z",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-03-25T21:19:59.431Z"
    }
  ],
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-03-25T21:19:59.431Z",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2025-03-25T21:19:59.431Z"
}

Status retrieved

Update an existing status given an ID

put

Authorizations

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

idstring · uuidrequired

Body

titlestringrequired

sub_titlestringrequired

typestring · enumrequired

Options: PENDING, PAID, INVOICED, CANCELLED

can_edit_by_customerbooleanrequired

can_edit_by_apibooleanrequired

show_in_portalbooleanrequired

background_colorstringrequired

font_colorstringrequired

relationsobject[]required

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.zydon.com.br/api/sales/status/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "sub_title": "text",
    "type": "PENDING",
    "can_edit_by_customer": true,
    "can_edit_by_api": true,
    "show_in_portal": true,
    "background_color": "text",
    "font_color": "text",
    "relations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "destiny": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "title": "text"
        }
      }
    ]
  }'

200

400

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-03-25T21:19:59.431Z",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2025-03-25T21:19:59.431Z"
}

Status updated

Remove an existing status given an ID

delete

Authorizations

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

idstring · uuidrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.zydon.com.br/api/sales/status/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Status removed

Retrieve a page of status

get

Authorizations

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Query parameters

searchstring · default: ""optional

pageinteger · int32 · default: 0optional

perPageinteger · int32 · default: 25optional

sortstring · default: "id"optional

dirstring · default: "asc"optional

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/status' \
  --header 'Authorization: Bearer JWT'

200

400

500

200

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "title": "text",
      "sub_title": "text",
      "type": "PENDING",
      "can_edit_by_customer": true,
      "can_edit_by_api": true,
      "show_in_portal": true,
      "background_color": "text",
      "font_color": "text",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-03-25T21:19:59.431Z",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-03-25T21:19:59.431Z"
    }
  ]
}

Status listed

Create a new status

post

Authorizations

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Body

namestringrequired

titlestringrequired

sub_titlestringrequired

typestring · enumrequired

Options: PENDING, PAID, INVOICED, CANCELLED

can_edit_by_customerbooleanrequired

can_edit_by_apibooleanrequired

show_in_portalbooleanrequired

background_colorstringrequired

font_colorstringrequired

relationsobject[]required

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.zydon.com.br/api/sales/status' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "title": "text",
    "sub_title": "text",
    "type": "PENDING",
    "can_edit_by_customer": true,
    "can_edit_by_api": true,
    "show_in_portal": true,
    "background_color": "text",
    "font_color": "text",
    "relations": [
      {
        "destiny": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "title": "text"
        }
      }
    ]
  }'

200

400

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "title": "text",
  "sub_title": "text",
  "type": "PENDING",
  "can_edit_by_customer": true,
  "can_edit_by_api": true,
  "show_in_portal": true,
  "background_color": "text",
  "font_color": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-03-25T21:19:59.431Z",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2025-03-25T21:19:59.431Z"
}

Status created