openapi-directory/api/vtex.local/Customer-Credit-API.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://vtex.local"},{"description":"VTEX server url","url":"https://{accountName}.{environment}.com.br","variables":{"accountName":{"default":"{accountName}","description":"Name of the VTEX account. Used as part of the URL"},"environment":{"default":"{environment}","description":"Environment to use. Used as part of the URL."}}}],"x-hasEquivalentPaths":true,"info":{"contact":{},"description":"With Customer Credit your store can enable **credit payments** through the checkout. You can also control **invoices** and the **credit limits** of your clients.\r\n\r\nLearn more about Customer Credit in our [Help Center article](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs).\r\n\r\nAll requests need the **authorization header**.\r\n\r\nAdditionally, you can find more information on installment payments for an order in the `customData`  field found in the [Get Order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-) endpoint of the Orders API. This includes the number of installments, amount and due dates.\r\n\r\nThis API allows two kinds of authorization:\r\n1. Authorization header containing the VTEX ID authentication token.\r\n2. VTEX Appkey and Apptoken headers.","title":"Customer Credit API","version":"1.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Customer Credit API.json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Customer-Credit-API"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"Invoices"},{"name":"Account"},{"name":"Store Configuration"}],"paths":{"/api/creditcontrol/accounts":{"get":{"deprecated":false,"description":"","operationId":"Searchallaccounts","parameters":[{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"data":[{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"}],"summary":{"count":39}},"schema":{"example":{"data":[{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"}],"summary":{"count":39}},"properties":{"data":{"description":"","items":{"example":{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"},"properties":{"account":{"type":"string"},"balance":{"type":"number"},"creditLimit":{"type":"number"},"description":{"type":"string"},"document":{"type":"string"},"documentType":{"type":"string"},"email":{"type":"string"},"lastUpdate":{"type":"string"}},"required":["account","balance","document","documentType","creditLimit","lastUpdate","description","email"],"title":"Datum2","type":"object"},"type":"array"},"summary":{"example":{"count":39},"properties":{"count":{"format":"int32","type":"integer"}},"required":["count"],"title":"Summary2","type":"object"}},"required":["data","summary"],"title":"Searchaccounts","type":"object"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"225","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:36:17 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.5-beta.1","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"beta","schema":{"type":"string"}}}},"X-Translate":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Translate-BackEnd":{"content":{"text/plain":{"example":"http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcreditcontrol%2Fcheckingaccounts%3Ffrom%3D9%26to%3D9","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.7-beta.5+75","schema":{"type":"string"}}}}}}},"summary":"Search all accounts","tags":["Account"]},"post":{"deprecated":false,"description":"Open an account.","operationId":"OpenanAccount","parameters":[{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"creditLimit":"number","description":"description","document":"number","documentType":"CPF ou CNPJ ou Other","email":"email","tolerance":"1 is 100%"},"schema":{"example":{"creditLimit":"number","description":"description","document":"number","documentType":"CPF ou CNPJ ou Other","email":"email","tolerance":"1 is 100%"},"properties":{"creditLimit":{"default":"500","type":"string"},"description":{"default":"example","type":"string"},"document":{"default":"99999999999","type":"string"},"documentType":{"default":"CPF","type":"string"},"email":{"default":"email@domain.com","type":"string"},"tolerance":{"default":"1","type":"string"}},"required":["document","documentType","email","creditLimit","description","tolerance"],"title":"OpenanAccountRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":"\"76655291437_CPF\"","schema":{"example":"\"76655291437_CPF\"","type":"string"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"17","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:47:35 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.5-beta.1","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"beta","schema":{"type":"string"}}}},"X-Translate":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Translate-BackEnd":{"content":{"text/plain":{"example":"http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcreditcontrol%2Fcheckingaccounts","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.7-beta.5+75","schema":{"type":"string"}}}}}}},"summary":"Open an Account","tags":["Account"]}},"/api/creditcontrol/accounts/{accountId}":{"put":{"deprecated":false,"description":"Open or Change an account.","operationId":"OpenorChangeAccount","parameters":[{"description":"It must be an alphanumeric value","in":"path","name":"accountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"creditLimit":"number","email":"email"},"schema":{"example":{"creditLimit":"number","email":"email"},"properties":{"creditLimit":{"default":"100.0","description":"If the user don't set a credit limit, the system will define 100 for default","type":"integer"},"document":{"default":"00221292404","type":"string"},"email":{"default":"email@email.com","type":"string"},"id":{"default":"teste","type":"string"}},"required":["email","id"],"title":"OpenorChangeAccountRequest","type":"object"}}},"description":""},"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":"\"76655291437_CPF\"","schema":{"example":"\"76655291437_CPF\"","type":"string"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"17","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:47:35 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.5-beta.1","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"beta","schema":{"type":"string"}}}},"X-Translate":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Translate-BackEnd":{"content":{"text/plain":{"example":"http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcreditcontrol%2Fcheckingaccounts","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.7-beta.5+75","schema":{"type":"string"}}}}}}},"summary":"Open or Change Account","tags":["Account"]}},"/api/creditcontrol/accounts/{creditAccountId}":{"delete":{"deprecated":false,"description":"Closes an account.","operationId":"CloseanAccount","parameters":[{"description":"Credit account's identifier","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"document":"number","documentType":"CPF ou CNPJ ou Other","email":"email"},"schema":{"example":{"document":"number","documentType":"CPF ou CNPJ ou Other","email":"email"},"properties":{"document":{"default":"99999999999","type":"string"},"documentType":{"default":"CPF","type":"string"},"email":{"default":"email@domain.com","type":"string"}},"title":"CloseanAccountRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"description":"","headers":{}}},"summary":"Close an Account","tags":["Account"]},"get":{"deprecated":false,"description":"Retrieve an account by id.","operationId":"RetrieveaAccountbyId","parameters":[{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"},"schema":{"example":{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"},"properties":{"account":{"type":"string"},"balance":{"type":"number"},"creditLimit":{"type":"number"},"description":{"type":"string"},"email":{"type":"string"},"lastUpdate":{"type":"string"}},"required":["account","balance","creditLimit","lastUpdate","description","email"],"title":"Getaccount","type":"object"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"145","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:28:47 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.4","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"stable","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.6-stable+62","schema":{"type":"string"}}}}}}},"summary":"Retrieve an Account by Id","tags":["Account"]},"put":{"deprecated":false,"description":"Update a checking account.","operationId":"Updateemailanddescriptionofaaccount","parameters":[{"description":"Credit account's identification","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"description":"string","email":"email"},"schema":{"example":{"description":"string","email":"email"},"properties":{"description":{"default":"example","type":"string"},"email":{"default":"email@domain.com","type":"string"}},"required":["description","email"],"title":"UpdateemailanddescriptionofaaccountRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":"\"76655291437_CPF\"","schema":{"example":"\"76655291437_CPF\"","type":"string"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"17","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:47:35 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.5-beta.1","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"beta","schema":{"type":"string"}}}},"X-Translate":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Translate-BackEnd":{"content":{"text/plain":{"example":"http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcreditcontrol%2Fcheckingaccounts","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.7-beta.5+75","schema":{"type":"string"}}}}}}},"summary":"Update email and description of a account","tags":["Account"]}},"/api/creditcontrol/accounts/{creditAccountId}/creditlimit":{"put":{"deprecated":false,"description":"Increase the credit limit of an account.","operationId":"ChangecreditlimitofanAccount","parameters":[{"description":"Credit account's identifier","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"value":10000},"schema":{"example":{"value":10000},"properties":{"value":{"default":"500.0","format":"number","type":"integer"}},"required":["value"],"title":"ChangecreditlimitofanAccountRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"text/plain":{"schema":{"type":"object"}}},"description":"","headers":{"connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"content-length":{"content":{"text/plain":{"example":"0","schema":{"type":"string"}}}},"date":{"content":{"text/plain":{"example":"Thu, 25 Jan 2018 13:35:21 GMT","schema":{"type":"string"}}}},"server":{"content":{"text/plain":{"example":"Microsoft-IIS/8.5","schema":{"type":"string"}}}},"via":{"content":{"text/plain":{"example":"1.1 localhost (squid/3.5.27)","schema":{"type":"string"}}}},"x-cache":{"content":{"text/plain":{"example":"MISS from localhost","schema":{"type":"string"}}}},"x-cache-lookup":{"content":{"text/plain":{"example":"MISS from localhost:3128","schema":{"type":"string"}}}},"x-powered-by":{"content":{"text/plain":{"example":"ASP.NET","schema":{"type":"string"}}}},"x-vtex-janus-router-backend-app":{"content":{"text/plain":{"example":"cc-v0.1.32-stable+145","schema":{"type":"string"}}}}}}},"summary":"Change credit limit of an Account","tags":["Account"]}},"/api/creditcontrol/accounts/{creditAccountId}/holders":{"post":{"deprecated":false,"description":"","operationId":"AddanaccountHolder","parameters":[{"description":"Credit account's identification","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"claims":{"email":"USER-EMAIL"}},"schema":{"example":{"claims":{"email":"USER-EMAIL"}},"properties":{"claims":{"example":{"email":"USER-EMAIL"},"properties":{"email":{"default":"email@domain.com","type":"string"}},"required":["email"],"title":"Claims","type":"object"}},"required":["claims"],"title":"AddanaccountHolderRequest","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"data":[{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"}],"summary":{"count":39}},"schema":{"example":{"data":[{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"}],"summary":{"count":39}},"properties":{"data":{"description":"","items":{"example":{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"},"properties":{"account":{"type":"string"},"balance":{"type":"number"},"creditLimit":{"type":"number"},"description":{"type":"string"},"document":{"type":"string"},"documentType":{"type":"string"},"email":{"type":"string"},"lastUpdate":{"type":"string"}},"required":["account","balance","document","documentType","creditLimit","lastUpdate","description","email"],"title":"Datum2","type":"object"},"type":"array"},"summary":{"example":{"count":39},"properties":{"count":{"format":"int32","type":"integer"}},"required":["count"],"title":"Summary2","type":"object"}},"required":["data","summary"],"title":"Searchcheckingaccounts","type":"object"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"225","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:36:17 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.5-beta.1","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"beta","schema":{"type":"string"}}}},"X-Translate":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Translate-BackEnd":{"content":{"text/plain":{"example":"http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcreditcontrol%2Fcheckingaccounts%3Ffrom%3D9%26to%3D9","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.7-beta.5+75","schema":{"type":"string"}}}}}}},"summary":"Add an account Holder","tags":["Account"]}},"/api/creditcontrol/accounts/{creditAccountId}/holders/{holderId}":{"delete":{"deprecated":false,"description":"","operationId":"Deleteanaccountholder","parameters":[{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Credit account's identification","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"","in":"path","name":"holderId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"data":[{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"}],"summary":{"count":39}},"schema":{"example":{"data":[{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"}],"summary":{"count":39}},"properties":{"data":{"description":"","items":{"example":{"account":"ambienteqa","balance":220,"creditLimit":240,"description":"","document":"12345677811","documentType":"CPF","email":"test@test.com","lastUpdate":"2025-04-15T13:51:55.621Z"},"properties":{"account":{"type":"string"},"balance":{"type":"number"},"creditLimit":{"type":"number"},"description":{"type":"string"},"document":{"type":"string"},"documentType":{"type":"string"},"email":{"type":"string"},"lastUpdate":{"type":"string"}},"required":["account","balance","document","documentType","creditLimit","lastUpdate","description","email"],"title":"Datum2","type":"object"},"type":"array"},"summary":{"example":{"count":39},"properties":{"count":{"format":"int32","type":"integer"}},"required":["count"],"title":"Summary2","type":"object"}},"required":["data","summary"],"title":"Searchcheckingaccounts","type":"object"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"225","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:36:17 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.5-beta.1","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"beta","schema":{"type":"string"}}}},"X-Translate":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Translate-BackEnd":{"content":{"text/plain":{"example":"http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcreditcontrol%2Fcheckingaccounts%3Ffrom%3D9%26to%3D9","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.7-beta.5+75","schema":{"type":"string"}}}}}}},"summary":"Delete an account holder","tags":["Account"]}},"/api/creditcontrol/accounts/{creditAccountId}/invoices":{"get":{"deprecated":false,"description":"Returns associated invoices by specified creditAccountId, the param that identifies a client in VTEX's system.","operationId":"SearchallinvoicesofaAccount","parameters":[{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"data":[{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"f9a056cb63f5417fb900ed5128bc1b15","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"ae45d73bfe534325bc6cfef3521d675c","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"8b984881a6934a06b65ab679c3b6641b","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"c19d55551ac84e2d84c5b60f53c77daa","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"b588919ac65a4bc58bc1b87957ca136a","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"fabb9ae209cb4c50ac048ab72363d488","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"bc4e409f1490495b8dc351e2f93ac766","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"b23eb606d9054e29a789745c1473d123","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"2f67b460ca0742118d5eadd7d3752480","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"36102b1baec74904a80dcc6baf8dd5e7","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"2166d1d0b35a4ece826fac580652348b","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"4d7ae513368a425db3c0c567fa2e9704","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"98332e38da024e269670bf6a5fce24ca","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"f2caa32762f14961895f93ddd1eb66cb","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"c44a7c0d2d944fe1bffc59b79ffdb214","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.621Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.621Z","id":"f5c4725b549e4e77bfbf69f9ec6b5f44","observation":"","originalDueDate":"2025-04-15T13:51:55.621Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.621Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"76054911732743e3b011a36fdf99ac9b","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"d5d5bc644d9e4068bb108bcca420343b","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"c8de1d1b4f144a8bbb339f2a1c873c7e","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"a84cc2c91ee048c2bcf94b3214af31b2","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"3bf5ea95cb75465e80ea8c0f16cbc4d2","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240}],"summary":{"count":194,"total":1740}},"schema":{"example":{"data":[{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"f9a056cb63f5417fb900ed5128bc1b15","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"ae45d73bfe534325bc6cfef3521d675c","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"8b984881a6934a06b65ab679c3b6641b","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"c19d55551ac84e2d84c5b60f53c77daa","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"b588919ac65a4bc58bc1b87957ca136a","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"fabb9ae209cb4c50ac048ab72363d488","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"bc4e409f1490495b8dc351e2f93ac766","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"b23eb606d9054e29a789745c1473d123","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"2f67b460ca0742118d5eadd7d3752480","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"36102b1baec74904a80dcc6baf8dd5e7","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"2166d1d0b35a4ece826fac580652348b","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"4d7ae513368a425db3c0c567fa2e9704","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"98332e38da024e269670bf6a5fce24ca","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"f2caa32762f14961895f93ddd1eb66cb","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"c44a7c0d2d944fe1bffc59b79ffdb214","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"f5c4725b549e4e77bfbf69f9ec6b5f44","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"76054911732743e3b011a36fdf99ac9b","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"d5d5bc644d9e4068bb108bcca420343b","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"c8de1d1b4f144a8bbb339f2a1c873c7e","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"a84cc2c91ee048c2bcf94b3214af31b2","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":20},{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"3bf5ea95cb75465e80ea8c0f16cbc4d2","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240}],"summary":{"count":194,"total":1740}},"properties":{"data":{"description":"","items":{"example":{"checkingAccountId":"12345677811_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice from debit of 240.0M. Installment 1/1","dueDate":"2025-04-15T13:51:55.622Z","id":"f9a056cb63f5417fb900ed5128bc1b15","observation":"","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":240},"properties":{"checkingAccountId":{"type":"string"},"createdAt":{"type":"string"},"description":{"type":"string"},"dueDate":{"type":"string"},"id":{"type":"string"},"observation":{"type":"string"},"originalDueDate":{"type":"string"},"paymentLink":{"type":"string"},"status":{"type":"string"},"updatedAt":{"type":"string"},"value":{"type":"number"}},"required":["id","status","value","checkingAccountId","createdAt","updatedAt","paymentLink","originalDueDate","dueDate","description","observation"],"title":"Datum1","type":"object"},"type":"array"},"summary":{"example":{"count":5,"total":500},"properties":{"count":{"format":"int32","type":"integer"},"total":{"type":"number"}},"required":["total","count"],"title":"Summary","type":"object"}},"required":["data","summary"],"title":"Getinvoicesfromacheckingaccount","type":"object"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"close","schema":{"type":"string"}}}},"Content-Encoding":{"content":{"text/plain":{"example":"gzip","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 20:30:00 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"Vary":{"content":{"text/plain":{"example":"Accept-Encoding","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.4","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"stable","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.6-stable+62","schema":{"type":"string"}}}}}}},"summary":"Retrieve invoice by creditAccountId","tags":["Invoices"]}},"/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}":{"delete":{"deprecated":false,"description":"Changes invoice's status from ancells invoice by specified Id.","operationId":"CancelInvoice","parameters":[{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Credit account's identification","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"","in":"path","name":"invoiceId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"object"}}},"description":"","headers":{"Access-Control-Allow-Origin":{"content":{"text/plain":{"example":"*","schema":{"type":"string"}}}},"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}}}},"Content-Length":{"content":{"text/plain":{"example":"0","schema":{"type":"string"}}}},"Date":{"content":{"text/plain":{"example":"Wed, 12 Jul 2017 21:06:17 GMT","schema":{"type":"string"}}}},"Server":{"content":{"text/plain":{"example":"nginx","schema":{"type":"string"}}}},"X-CDNIgnore":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Powered-by-VTEX-Janus-Edge":{"content":{"text/plain":{"example":"v1.36.5-beta.1","schema":{"type":"string"}}}},"X-Track":{"content":{"text/plain":{"example":"beta","schema":{"type":"string"}}}},"X-Translate":{"content":{"text/plain":{"example":"1","schema":{"type":"string"}}}},"X-Translate-BackEnd":{"content":{"text/plain":{"example":"http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcreditcontrol%2Fcheckingaccounts%2F76655291437_CPF%2Finvoices%2F8735068e9aa042488e7cd2a0d3028ce7","schema":{"type":"string"}}}},"X-VTEX-Janus-Router-Backend-App":{"content":{"text/plain":{"example":"cc-v0.1.7-beta.5+75","schema":{"type":"string"}}}}}}},"summary":"Cancel Invoice","tags":["Invoices"]},"get":{"deprecated":false,"description":"Returns associated data for the specified Invoice Id, like status  and value, for example.","operationId":"RetrieveInvoicebyId","parameters":[{"description":"The Media type of the body of the request. Default value for payment provider protocol is application/json","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Credit account's identification","in":"path","name":"creditAccountId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"},{"description":"","in":"path","name":"invoiceId","required":true,"schema":{"default":"insert identifier here","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json; charset=utf-8":{"example":{"checkingAccountId":"76655291437_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice issued from a API call","dueDate":"2025-04-15T13:51:55.622Z","id":"029f4009-ac4b-4739-8644-50df050f34ca","observation":"Some observation about the invoice","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"http://foo.bar","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":50},"schema":{"example":{"checkingAccountId":"76655291437_CPF","createdAt":"2025-04-15T13:51:55.622Z","description":"Invoice issued from a API call","dueDate":"2025-04-15T13:51:55.622Z","id":"029f4009-ac4b-4739-8644-50df050f34ca","observation":"Some observation about the invoice","originalDueDate":"2025-04-15T13:51:55.622Z","paymentLink":"http://foo.bar","status":"Opened","updatedAt":"2025-04-15T13:51:55.622Z","value":50},"properties":{"checkingAccountId":{"type":"string"},"createdAt":{"type":"string"},"description":{"type":"string"},"dueDate":{"type":"string"},"id":{"type":"string"},"observation":{"type":"string"},"originalDueDate":{"type":"string"},"paymentLink":{"type":"string"},"status":{"type":"string"},"updatedAt":{"type":"string"},"value":{"type":"number"}},"required":["id","status","value","checkingAccountId","createdAt","updatedAt","paymentLink","originalDueDate","dueDate","description","observation"],"title":"Retrievedinvoice","type":"object"}}},"description":"","headers":{"Connection":{"content":{"text/plain":{"example":"keep-alive","schema":{"type":"string"}