Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CREDIT/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "CreditNote": "string", "ApprovalStatus": "string", "AutoCreditDiscount": 0, "Id": "string", "CreditDate": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "BillingProfileId": "string", "VoidCreditId": 0, "TaxEngineRequestId": 0, "Created": "string", "Autoallocate": 0, "CreatedUserId": "string", "VoidedCreditId": 0, "UnassignedCreditNote": "string", "ApproveRejectedUser": 0, "AutoCreditTax": 0, "CreditType": "string", "ApprovalNotes": "string", "AutoCreditAssociatedProduct": 0, "SourceRefundId": 0, "ApprovedRejectedDate": "string", "AutoApproved": 0, "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "CreditCardName": "string", "Updated": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CREDIT?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "CreditNote": "string", "ApprovalStatus": "string", "AutoCreditDiscount": 0, "Id": "string", "CreditDate": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "BillingProfileId": "string", "VoidCreditId": 0, "TaxEngineRequestId": 0, "Created": "string", "Autoallocate": 0, "CreatedUserId": "string", "VoidedCreditId": 0, "UnassignedCreditNote": "string", "ApproveRejectedUser": 0, "AutoCreditTax": 0, "CreditType": "string", "ApprovalNotes": "string", "AutoCreditAssociatedProduct": 0, "SourceRefundId": 0, "ApprovedRejectedDate": "string", "AutoApproved": 0, "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "CreditCardName": "string", "Updated": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CREDIT \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CreditNote": "string", "ApprovalStatus": "string", "AutoCreditDiscount": 0, "Id": "string", "CreditDate": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "BillingProfileId": "string", "VoidCreditId": 0, "TaxEngineRequestId": 0, "Created": "string", "Autoallocate": 0, "CreatedUserId": "string", "VoidedCreditId": 0, "UnassignedCreditNote": "string", "ApproveRejectedUser": 0, "AutoCreditTax": 0, "CreditType": "string", "ApprovalNotes": "string", "AutoCreditAssociatedProduct": 0, "SourceRefundId": 0, "ApprovedRejectedDate": "string", "AutoApproved": 0, "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "CreditCardName": "string", "Updated": "string" } }'
{ "retrieveResponse": { "CreditNote": "string", "ApprovalStatus": "string", "AutoCreditDiscount": 0, "Id": "string", "CreditDate": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "BillingProfileId": "string", "VoidCreditId": 0, "TaxEngineRequestId": 0, "Created": "string", "Autoallocate": 0, "CreatedUserId": "string", "VoidedCreditId": 0, "UnassignedCreditNote": "string", "ApproveRejectedUser": 0, "AutoCreditTax": 0, "CreditType": "string", "ApprovalNotes": "string", "AutoCreditAssociatedProduct": 0, "SourceRefundId": 0, "ApprovedRejectedDate": "string", "AutoApproved": 0, "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "CreditCardName": "string", "Updated": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/CREDIT \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CreditNote": "string", "ApprovalStatus": "string", "AutoCreditDiscount": 0, "Id": "string", "CreditDate": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "BillingProfileId": "string", "VoidCreditId": 0, "TaxEngineRequestId": 0, "Created": "string", "Autoallocate": 0, "CreatedUserId": "string", "VoidedCreditId": 0, "UnassignedCreditNote": "string", "ApproveRejectedUser": 0, "AutoCreditTax": 0, "CreditType": "string", "ApprovalNotes": "string", "AutoCreditAssociatedProduct": 0, "SourceRefundId": 0, "ApprovedRejectedDate": "string", "AutoApproved": 0, "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "CreditCardName": "string", "Updated": "string" } }'
{ "retrieveResponse": { "CreditNote": "string", "ApprovalStatus": "string", "AutoCreditDiscount": 0, "Id": "string", "CreditDate": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "BillingProfileId": "string", "VoidCreditId": 0, "TaxEngineRequestId": 0, "Created": "string", "Autoallocate": 0, "CreatedUserId": "string", "VoidedCreditId": 0, "UnassignedCreditNote": "string", "ApproveRejectedUser": 0, "AutoCreditTax": 0, "CreditType": "string", "ApprovalNotes": "string", "AutoCreditAssociatedProduct": 0, "SourceRefundId": 0, "ApprovedRejectedDate": "string", "AutoApproved": 0, "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "CreditCardName": "string", "Updated": "string" } }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/CREDIT \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "CreditNote": "string", "ApprovalStatus": "string", "AutoCreditDiscount": 0, "Id": "string", "CreditDate": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "BillingProfileId": "string", "VoidCreditId": 0, "TaxEngineRequestId": 0, "Created": "string", "Autoallocate": 0, "CreatedUserId": "string", "VoidedCreditId": 0, "UnassignedCreditNote": "string", "ApproveRejectedUser": 0, "AutoCreditTax": 0, "CreditType": "string", "ApprovalNotes": "string", "AutoCreditAssociatedProduct": 0, "SourceRefundId": 0, "ApprovedRejectedDate": "string", "AutoApproved": 0, "InvoiceIdDisplay": "string", "UpdatedUserId": "string", "CreditCardExpDate": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "InvoiceDetail": 0, "ApprovalRejectedNote": "string", "AccountProductId": 0, "CreditCardName": "string", "Updated": "string" } }