- Criado por Alexandre Claudino ontem às 5:46 PM
POST /accountingmovement
Descrição
O endpoint POST /accountingmovement
é utilizado para incluir registros na tabela CTB_MOVIMENTO_B2C
. Esse serviço permite a criação de movimentações contábeis associadas a transações financeiras.
Parâmetros
Este endpoint não requer parâmetros na URL.
Corpo da Requisição
O corpo da requisição deve ser enviado no formato JSON e deve conter os seguintes campos:
[ { "BranchId": "string", "OrderOriginId": "string", "DeliveryOriginId": "string", "PaymentNumber": "string", "PaymentTypeId": "string", "DateEntry": "2024-07-20T01:41:45.352Z", "DueDate": "2024-07-20T01:41:45.352Z", "AmountPaid": 0, "CustomerId": "string", "Installments": 0, "AdministratorId": "string", "TitleNumber": "string", "VoucherKey": "string", "ApprovalCode": "string", "Relocated": true, "PaymentDate": "2024-07-20T01:41:45.353Z" } ]
Descrição dos Campos
- BranchId: ID da filial.
- OrderOriginId: ID de origem do pedido.
- DeliveryOriginId: ID de origem da entrega.
- PaymentNumber: Número do pagamento.
- PaymentTypeId: ID do tipo de pagamento.
- DateEntry: Data de entrada da movimentação.
- DueDate: Data de vencimento.
- AmountPaid: Valor pago.
- CustomerId: ID do cliente.
- Installments: Número de parcelas.
- AdministratorId: ID do administrador.
- TitleNumber: Número do título.
- VoucherKey: Chave do voucher.
- ApprovalCode: Código de aprovação.
- Relocated: Indica se a movimentação foi relocada (true/false).
- PaymentDate: Data do pagamento.
Respostas
Sucesso (200)
{ "success": [ { "BranchId": "string", "OrderOriginId": "string", "DeliveryOriginId": "string", "PaymentNumber": "string", "PaymentTypeId": "string", "DateEntry": "2024-07-20T01:41:45.384Z", "DueDate": "2024-07-20T01:41:45.384Z", "AmountPaid": 0, "CustomerId": "string", "Installments": 0, "AdministratorId": "string", "TitleNumber": "string", "VoucherKey": "string", "ApprovalCode": "string", "Relocated": true, "PaymentDate": "2024-07-20T01:41:45.384Z" } ] }
Essa resposta indica que a inclusão do registro foi bem-sucedida.
Não autorizado (401)
Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.
Erro Interno (500)
{ "erro": "string", "stackTrace": "string" }
Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro
fornece uma descrição do erro, e stackTrace
pode conter informações adicionais para diagnóstico.
PUT /accountingmovement
Descrição
O endpoint PUT /accountingmovement
é utilizado para atualizar registros existentes na tabela CTB_MOVIMENTO_B2C
. Esse serviço permite a modificação de movimentações contábeis associadas a transações financeiras já cadastradas.
Parâmetros
Este endpoint não requer parâmetros na URL.
Corpo da Requisição
O corpo da requisição deve ser enviado no formato JSON e deve conter os seguintes campos:
[ { "BranchId": "string", "OrderOriginId": "string", "DeliveryOriginId": "string", "PaymentNumber": "string", "PaymentTypeId": "string", "DateEntry": "2024-07-20T01:54:29.472Z", "DueDate": "2024-07-20T01:54:29.472Z", "AmountPaid": 0, "CustomerId": "string", "Installments": 0, "AdministratorId": "string", "TitleNumber": "string", "VoucherKey": "string", "ApprovalCode": "string", "Relocated": true, "PaymentDate": "2024-07-20T01:54:29.472Z" } ]
Descrição dos Campos
- BranchId: ID da filial.
- OrderOriginId: ID de origem do pedido.
- DeliveryOriginId: ID de origem da entrega.
- PaymentNumber: Número do pagamento.
- PaymentTypeId: ID do tipo de pagamento.
- DateEntry: Data de entrada da movimentação.
- DueDate: Data de vencimento.
- AmountPaid: Valor pago.
- CustomerId: ID do cliente.
- Installments: Número de parcelas.
- AdministratorId: ID do administrador.
- TitleNumber: Número do título.
- VoucherKey: Chave do voucher.
- ApprovalCode: Código de aprovação.
- Relocated: Indica se a movimentação foi relocada (true/false).
- PaymentDate: Data do pagamento.
Sucesso (200)
{ "success": [ { "BranchId": "string", "OrderOriginId": "string", "DeliveryOriginId": "string", "PaymentNumber": "string", "PaymentTypeId": "string", "DateEntry": "2024-07-20T01:54:29.496Z", "DueDate": "2024-07-20T01:54:29.496Z", "AmountPaid": 0, "CustomerId": "string", "Installments": 0, "AdministratorId": "string", "TitleNumber": "string", "VoucherKey": "string", "ApprovalCode": "string", "Relocated": true, "PaymentDate": "2024-07-20T01:54:29.496Z" } ], "error": [ { "erro": "string", "stackTrace": "string" } ] }
Essa resposta indica que a inclusão do registro foi bem-sucedida.
Não autorizado (401)
Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.
Erro Interno (500)
{ "erro": "string", "stackTrace": "string" }
Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro
fornece uma descrição do erro, e stackTrace
pode conter informações adicionais para diagnóstico.
GET /accountingmovement/order/{orderId}/fulfillment/{fulfillmentId}
Descrição
O endpoint GET /accountingmovement/order/{orderId}/fulfillment/{fulfillmentId}
é utilizado para pesquisar registros na tabela CTB_MOVIMENTO_B2C
com base nos identificadores de origem do pedido (OrderOriginId
) e de origem da entrega (DeliveryOriginId
).
Parâmetros
Parâmetros na URL
- orderId (obrigatório): Identificador de origem do pedido (
OrderOriginId
). - fulfillmentId (obrigatório): Identificador de origem da entrega (
DeliveryOriginId
).
Parâmetros na Query
- page_size (opcional): Quantidade de registros por página.
- current_page (opcional): Página corrente.
Respostas
Sucesso (200)
{ "Pagination": { "TotalCount": 0, "PageSize": 0, "CurrentPage": 0 }, "Items": [ { "InvoiceId": "string", "BranchId": "string", "OrderId": 0, "OrderOriginId": "string", "DeliveryOriginId": "string", "PaymentNumber": "string", "PaymentTypeId": "string", "PaymentDate": "2024-07-20T02:02:25.096Z", "DueDate": "2024-07-20T02:02:25.096Z", "AmountPaid": 0, "CustomerId": "string", "Installments": 0, "AdministratorId": "string", "ApprovalCode": "string", "VoucherKey": "string", "TitleNumber": "string", "Relocated": true, "Canceled": true, "UpdateDate": "2024-07-20T02:02:25.096Z" } ] }
Essa resposta indica que a pesquisa foi bem-sucedida e retorna os dados dos registros correspondentes.
Não autorizado (401)
Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.
Erro Interno (500)
{ "erro": "string", "stackTrace": "string" }
Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro
fornece uma descrição do erro, e stackTrace
pode conter informações adicionais para diagnóstico.
GET /accountingmovement/transferDate/{date}
Descrição
O endpoint GET /accountingmovement/transferDate/{date}
é utilizado para pesquisar registros na tabela CTB_MOVIMENTO_B2C
com base na data de alteração (data_para_transferencia
).
Parâmetros na URL
- date (obrigatório): Data de alteração (
data_para_transferencia
) no formatodate-time
.
Parâmetros na Query
- page_size (opcional): Quantidade de registros por página.
- current_page (opcional): Página corrente.
Respostas
Sucesso (200)
{ "Pagination": { "TotalCount": 0, "PageSize": 0, "CurrentPage": 0 }, "Items": [ { "InvoiceId": "string", "BranchId": "string", "OrderId": 0, "OrderOriginId": "string", "DeliveryOriginId": "string", "PaymentNumber": "string", "PaymentTypeId": "string", "PaymentDate": "2024-07-20T02:10:53.380Z", "DueDate": "2024-07-20T02:10:53.380Z", "AmountPaid": 0, "CustomerId": "string", "Installments": 0, "AdministratorId": "string", "ApprovalCode": "string", "VoucherKey": "string", "TitleNumber": "string", "Relocated": true, "Canceled": true, "UpdateDate": "2024-07-20T02:10:53.380Z" } ] }
Essa resposta indica que a pesquisa foi bem-sucedida e retorna os dados dos registros correspondentes.
Não autorizado (401)
Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.
Erro Interno (500)
{ "erro": "string", "stackTrace": "string" }
Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro
fornece uma descrição do erro, e stackTrace
pode conter informações adicionais para diagnóstico.
Exemplo do Swagger: