POST query/PublicQuery/CustomerBalanceQuery
Consulta del estado de cuentas de un cliente
Request Information
URI Parameters
None.
Body Parameters
RequestQueryOfCustomerBalanceQuery| Name | Description | Additional information | Type |
|---|---|---|---|
| QueryCredentials |
Credenciales |
Required |
QueryCredentials |
| QueryRequest |
Petición |
Required |
CustomerBalanceQuery |
Request Formats
application/json, text/json
Sample:
{
"QueryCredentials": {
"User": "sample string 1",
"Password": "sample string 2",
"UserPasswordToken": "sample string 3"
},
"QueryRequest": {
"QueryHeader": {
"HotelCodeMap": {
"HotelSourceCode": "sample string 1",
"HotelTargetCode": "sample string 2"
},
"MaxRowsResponse": 1,
"Source": "sample string 2"
},
"CustomerCode": {
"CustomerCode": "sample string 1"
},
"UserID": "e27b4b96-4e18-45b3-a677-dc8ebe24dd24"
}
}
application/xml, text/xml
Sample:
<RequestQueryOfCustomerBalanceQueryXlwkY1rK xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorSVC.Contracts.Requests">
<QueryCredentials xmlns:d2p1="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorSVC.Contracts.Security">
<d2p1:Password>sample string 2</d2p1:Password>
<d2p1:User>sample string 1</d2p1:User>
<d2p1:UserPasswordToken>sample string 3</d2p1:UserPasswordToken>
</QueryCredentials>
<QueryRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Queries.Financials.Balance.BalanceAR">
<UserID xmlns="http://schemas.datacontract.org/2004/07/WH_CQRS.DomainQueries">e27b4b96-4e18-45b3-a677-dc8ebe24dd24</UserID>
<d2p1:CustomerCode xmlns:d3p1="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Commons.Parameters.Financials">
<d3p1:CustomerCode>sample string 1</d3p1:CustomerCode>
</d2p1:CustomerCode>
<d2p1:QueryHeader xmlns:d3p1="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Commons.Parameters">
<d3p1:HotelCodeMap xmlns:d4p1="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Commons.HotelSettings">
<d4p1:HotelSourceCode>sample string 1</d4p1:HotelSourceCode>
<d4p1:HotelTargetCode>sample string 2</d4p1:HotelTargetCode>
</d3p1:HotelCodeMap>
<d3p1:MaxRowsResponse>1</d3p1:MaxRowsResponse>
<d3p1:Source>sample string 2</d3p1:Source>
</d2p1:QueryHeader>
</QueryRequest>
</RequestQueryOfCustomerBalanceQueryXlwkY1rK>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CustomerBalanceQueryResponse| Name | Description | Additional information | Type |
|---|---|---|---|
| CustomerBalance |
Saldo de cliente |
CustomerBalance | |
| Success |
Es válida |
boolean | |
| Error |
Error |
string |
Response Formats
application/json, text/json
Sample:
{
"CustomerBalance": {
"CustomerCode": "sample string 1",
"CustomerName": "sample string 2",
"Balance": [
{
"CurrencyCode": "sample string 1",
"InvoicedAmount": 2.0,
"ReceiptedAmount": 3.0,
"BalanceAmount": 4.0,
"Invoices": [
{
"Code": "sample string 1",
"CustomerCode": "sample string 2",
"CurrencyCode": "sample string 3",
"InvoiceDate": "2025-04-30T12:40:45.2981107+02:00",
"AmountAfterTaxes": 5.0,
"Received": 6.0,
"AmountBeforeTaxes": 7.0,
"Taxes": 8.0,
"InvoiceBalance": 9.0,
"InvoiceLines": [
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
},
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
}
],
"Receipts": [
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
},
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
}
]
},
{
"Code": "sample string 1",
"CustomerCode": "sample string 2",
"CurrencyCode": "sample string 3",
"InvoiceDate": "2025-04-30T12:40:45.2981107+02:00",
"AmountAfterTaxes": 5.0,
"Received": 6.0,
"AmountBeforeTaxes": 7.0,
"Taxes": 8.0,
"InvoiceBalance": 9.0,
"InvoiceLines": [
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
},
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
}
],
"Receipts": [
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
},
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
}
]
}
]
},
{
"CurrencyCode": "sample string 1",
"InvoicedAmount": 2.0,
"ReceiptedAmount": 3.0,
"BalanceAmount": 4.0,
"Invoices": [
{
"Code": "sample string 1",
"CustomerCode": "sample string 2",
"CurrencyCode": "sample string 3",
"InvoiceDate": "2025-04-30T12:40:45.2981107+02:00",
"AmountAfterTaxes": 5.0,
"Received": 6.0,
"AmountBeforeTaxes": 7.0,
"Taxes": 8.0,
"InvoiceBalance": 9.0,
"InvoiceLines": [
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
},
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
}
],
"Receipts": [
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
},
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
}
]
},
{
"Code": "sample string 1",
"CustomerCode": "sample string 2",
"CurrencyCode": "sample string 3",
"InvoiceDate": "2025-04-30T12:40:45.2981107+02:00",
"AmountAfterTaxes": 5.0,
"Received": 6.0,
"AmountBeforeTaxes": 7.0,
"Taxes": 8.0,
"InvoiceBalance": 9.0,
"InvoiceLines": [
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
},
{
"StartDate": "2025-04-30T12:40:45.2981107+02:00",
"EndDate": "2025-04-30T12:40:45.2981107+02:00",
"ProductCode": "sample string 3",
"Description": "sample string 4",
"Quantity": 5.0,
"AmountAfterTaxes": 6.0,
"AmountBeforeTaxes": 7.0,
"CurrencyCode": "sample string 8"
}
],
"Receipts": [
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
},
{
"Date": "2025-04-30T12:40:45.2981107+02:00",
"Amount": 2.0,
"CurrencyCode": "sample string 3"
}
]
}
]
}
]
},
"Success": true,
"Error": "sample string 2"
}
application/xml, text/xml
Sample:
<CustomerBalanceQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Commons.Responses.Financials">
<Error xmlns="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Commons.Responses">sample string 2</Error>
<Success xmlns="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Commons.Responses">true</Success>
<CustomerBalance xmlns:d2p1="http://schemas.datacontract.org/2004/07/PMS.QueryProcessorBC.Commons.Financials">
<d2p1:Balance>
<d2p1:Balance>
<d2p1:BalanceAmount>4</d2p1:BalanceAmount>
<d2p1:CurrencyCode>sample string 1</d2p1:CurrencyCode>
<d2p1:InvoicedAmount>2</d2p1:InvoicedAmount>
<d2p1:Invoices>
<d2p1:Invoice>
<d2p1:AmountAfterTaxes>5</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:CustomerCode>sample string 2</d2p1:CustomerCode>
<d2p1:InvoiceBalance>9</d2p1:InvoiceBalance>
<d2p1:InvoiceDate>2025-04-30T12:40:45.2981107+02:00</d2p1:InvoiceDate>
<d2p1:InvoiceLines>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
</d2p1:InvoiceLines>
<d2p1:Receipts>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
</d2p1:Receipts>
<d2p1:Received>6</d2p1:Received>
<d2p1:Taxes>8</d2p1:Taxes>
</d2p1:Invoice>
<d2p1:Invoice>
<d2p1:AmountAfterTaxes>5</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:CustomerCode>sample string 2</d2p1:CustomerCode>
<d2p1:InvoiceBalance>9</d2p1:InvoiceBalance>
<d2p1:InvoiceDate>2025-04-30T12:40:45.2981107+02:00</d2p1:InvoiceDate>
<d2p1:InvoiceLines>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
</d2p1:InvoiceLines>
<d2p1:Receipts>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
</d2p1:Receipts>
<d2p1:Received>6</d2p1:Received>
<d2p1:Taxes>8</d2p1:Taxes>
</d2p1:Invoice>
</d2p1:Invoices>
<d2p1:ReceiptedAmount>3</d2p1:ReceiptedAmount>
</d2p1:Balance>
<d2p1:Balance>
<d2p1:BalanceAmount>4</d2p1:BalanceAmount>
<d2p1:CurrencyCode>sample string 1</d2p1:CurrencyCode>
<d2p1:InvoicedAmount>2</d2p1:InvoicedAmount>
<d2p1:Invoices>
<d2p1:Invoice>
<d2p1:AmountAfterTaxes>5</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:CustomerCode>sample string 2</d2p1:CustomerCode>
<d2p1:InvoiceBalance>9</d2p1:InvoiceBalance>
<d2p1:InvoiceDate>2025-04-30T12:40:45.2981107+02:00</d2p1:InvoiceDate>
<d2p1:InvoiceLines>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
</d2p1:InvoiceLines>
<d2p1:Receipts>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
</d2p1:Receipts>
<d2p1:Received>6</d2p1:Received>
<d2p1:Taxes>8</d2p1:Taxes>
</d2p1:Invoice>
<d2p1:Invoice>
<d2p1:AmountAfterTaxes>5</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:CustomerCode>sample string 2</d2p1:CustomerCode>
<d2p1:InvoiceBalance>9</d2p1:InvoiceBalance>
<d2p1:InvoiceDate>2025-04-30T12:40:45.2981107+02:00</d2p1:InvoiceDate>
<d2p1:InvoiceLines>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
<d2p1:InvoiceLine>
<d2p1:AmountAfterTaxes>6</d2p1:AmountAfterTaxes>
<d2p1:AmountBeforeTaxes>7</d2p1:AmountBeforeTaxes>
<d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:EndDate>2025-04-30T12:40:45.2981107+02:00</d2p1:EndDate>
<d2p1:ProductCode>sample string 3</d2p1:ProductCode>
<d2p1:Quantity>5</d2p1:Quantity>
<d2p1:StartDate>2025-04-30T12:40:45.2981107+02:00</d2p1:StartDate>
</d2p1:InvoiceLine>
</d2p1:InvoiceLines>
<d2p1:Receipts>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
<d2p1:Receipt>
<d2p1:Amount>2</d2p1:Amount>
<d2p1:CurrencyCode>sample string 3</d2p1:CurrencyCode>
<d2p1:Date>2025-04-30T12:40:45.2981107+02:00</d2p1:Date>
</d2p1:Receipt>
</d2p1:Receipts>
<d2p1:Received>6</d2p1:Received>
<d2p1:Taxes>8</d2p1:Taxes>
</d2p1:Invoice>
</d2p1:Invoices>
<d2p1:ReceiptedAmount>3</d2p1:ReceiptedAmount>
</d2p1:Balance>
</d2p1:Balance>
<d2p1:CustomerCode>sample string 1</d2p1:CustomerCode>
<d2p1:CustomerName>sample string 2</d2p1:CustomerName>
</CustomerBalance>
</CustomerBalanceQueryResponse>