Lista de Grupo de Faturamento

GET /billingGroup/list

HTTP

GET /billingGroup/list HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}

Para listar os campos disponiveis por produtos, utilizamos a seguinte url: {{url}}/billingGroup/list

URL Params

Query string	Tipo	Descrição	Obrigatório
fields	Query string	O valor da query é os campos disponiveis separados por virgulas, query usada para montar o retorno do objeto.	✗
conditions[fieldName]	Query string	O valor da query é o dado do campo informado entre os "[]", query usada como condição para filtrar o retorno de dados.	✗

Campos disponiveis para montar o objeto e / ou filtrar a lista.

Campo	Query string	Descrição	Obrigatório
id	fields & conditions[fieldName]	Identificador	✗
alterado_em	fields & conditions[fieldName]	Mostra quando os dados foram alterados	✗
alterado_por	fields & conditions[fieldName]	Mostra quem alterou os dados	✗
criado_em	fields & conditions[fieldName]	Mostra quando os dados foram criados	✗
codigo_faturamento	fields & conditions[fieldName]	Código do grupo de faturamento	✗
descricao	fields & conditions[fieldName]	Descrição do grupo de faturamento	✗
codigo_integracao	fields & conditions[fieldName]	Código de integração	✗
codigo_produto	fields & conditions[fieldName]	Código do produto associado ao grupo de faturamento	✗

Requisição

GET

GET {{url}}/billingGroup/list

Resposta

200

{
    "status": "success",
    "message": "Lista de grupo de pagamentos",
    "document": [
        {
            "id": 4,
            "alterado_em": "2024-07-17T16:57:40.483Z",
            "alterado_por": "SYSTEM",
            "criado_em": "2024-07-17T16:57:40.483Z",
            "codigo_faturamento": 1,
            "descricao": "Ecommerce",
            "codigo_integracao": 40,
            "codigo_produto": 1
        }
    ],
    "rowsAffected": [
        1
    ]
}

Errors

Código	Referência	Explicação
400	BAD REQUEST	O servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401	UNAUTHORIZED	O servidor não autorizou a requisição. Access Token inválido.
403	FORBIDDEN	O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404	NOT FOUND	O servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422	UNPROCESSABLE ENTITY	O servidor não conseguiu processar as informações contidas na requisição.